Prodigi API Rubygem

The easiest and most complete rubygem for Prodigi Worldwide Printing Service. Currently supports API v4.

Add this line to your application's Gemfile:

gem 'prodigi'

And then execute:

$ bundle

Or install it yourself as:

$ gem install prodigi

To access the API, you'll need to create a Prodigi::Client and pass in your API key. You can find your API key at https://dashboard.prodigi.com/settings/integrations

Defaults to sandbox unless the base url is changed to "https://api.prodigi.com/v4.0" either by setting the PRODIGI_API_URL environment variable or passing it as base_url when creating the client.

client = Prodigi::Client.new(api_key: ENV["PRODIGI_API_KEY"])

If you want to set the base_url you can pass it when creating the client.

client = Prodigi::Client.new(base_url: "https://api.sandbox.prodigi.com/v4.0", api_key: ENV["PRODIGI_API_KEY"])

The client then gives you access to each of the resources.

The gem maps as closely as we can to the Prodigi API so you can easily convert API examples to gem code.

Responses are created as objects like Prodigi::Order. Having types like Prodigi::Quote is handy for understanding what type of object you're working with. They're built using OpenStruct so you can easily access data in a Ruby-ish way.

client.orders.list
client.orders.create({})
client.orders.retrieve(prodigi_order_id: "id")
client.orders.actions(prodigi_order_id: "id")
client.orders.update_shipping(prodigi_order_id: "id", {})
client.orders.update_recipient(prodigi_order_id: "id", {})
client.orders.update_metadata(prodigi_order_id: "id", {})
client.orders.cancel(prodigi_order_id: "id", {})

client.quotes.create({})

client.products.details(sku: "sku")

If you would like more debugging information showing API responses you can enable debugging output when you create the client.

client = Prodigi::Client.new(api_key: ..., debug: true)

This will log additional output to stdout, or you can pass in a different logger.

client = Prodigi::Client.new(api_key: ..., debug: true, logger: MySpecialLogger)

1. Fork it ( https://github.com/rdtclark/prodigi/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

When adding methods, add to the list of DEFINITIONS in lib/prodigi.rb. Additionally, write a spec and add it to the list in the README.

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