Giter VIP home page Giter VIP logo

shippingeasy_integration's Introduction

Shippingeasy Integration CircleCI

Deploy

!!!!!!!!!!!! DOCUMENTATIONS WIP !!!!!!!!!!!!!!!!!

This is an integration for use with the Cangaroo open source project.

Connection Parameters

The following parameters must be setup into your Cangaroo Job:

Name Value
api_key ShippingEasy API Access Token (required)
api_secret ShippingEasy API Token Secret (required)

Webhooks

The following webhooks are implemented:

Name Description
/send_order Send the given order to Shipping Easy

Installation on rails app

Add this line to your application's Gemfile:

gem 'shippingeasy_integration'

mount in routes.rb:

mount ShippingeasyIntegration::Server => "/shipping_easy"

And then execute:

$ bundle

Installation as hosted app

$ gem install shippingeasy_integration
$ bundle exec rackup

Usage

Create cangaroo connection:

Cangaroo::Connection.create(
  name: 'shipping_easy',
  url: 'http://localhost:5000',
  key: 'secret_key_shipping_easy',
  token: 'secret_token_shipping_easy'
)

Create cangaroo job:

 bundle exec rails g job Cangaroo::ShippingEasyCreateOrder

Change /jobs/cangaroo/shipping_easy_create_order_job.rb to:

module Cangaroo
  class ShippingEasyCreateOrderJob < Cangaroo::Job
    connection 'shipping_easy'
    path '/create_order'
    parameters(api_key: ENV['SHIPPING_EASY_API_KEY'],
               api_secret: ENV['SHIPPING_EASY_API_SECRET'])

    def perform?
      type == 'orders'
    end
  end
end

Add as job cangaroo.rb in config/initializer with:

Rails.configuration.cangaroo.jobs = [Cangaroo::ShippingEasyCreateOrderJob]

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/shippingeasy_integration.

License

The gem is available as open source under the terms of the MIT License.

shippingeasy_integration's People

Contributors

misteral avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Forkers

sweetist

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.