prodigi 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85b513da35ef1844f970271bb663a50fc090b34c8ecdc009d1cb3fa27f4b7941
+  data.tar.gz: 4f550491b3fe9daf8678eebc9ff00e1650702b82162ab4f3c2419c673005cbab
+SHA512:
+  metadata.gz: f74ae257ba2296ec5397faaa55dfb400b1c3103ba4da0580b1220b8c6f2a21c7456313d0da0bd4f2b720f742670e9c65bf20e249902f8276890fa3c926ed4c4d
+  data.tar.gz: 760e033a45dc23c42a0530821523237d3fb5e78b74f534588beb61c7054b3871322f2a9520d3b7dcf9966edf6522f7a80e8bdfbb7f92cf8bf88daa09288dda74

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-01-16
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at robindtclark@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in prodigi.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    prodigi (0.1.1)
+      faraday (~> 1.8)
+      faraday_middleware (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    faraday (1.9.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    minitest (5.15.0)
+    multipart-post (2.1.1)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rubocop (1.25.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  prodigi!
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.2.32

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Robin Clark
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# Prodigi API Rubygem
+
+The easiest and most complete rubygem for [Prodigi](https://www.prodigi.com) Worldwide Printing Service. Currently supports [API v4](https://www.prodigi.com/print-api/docs/reference/#introduction).
+ 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prodigi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prodigi
+
+## Usage
+
+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
+
+API URL defaults to sandbox unless PRODIGI_API_URL env variable  exists with live url present.
+
+```ruby
+client = Prodigi::Client:new(api_key: ENV["PRODIGI_API_KEY"])
+```
+
+The client then gives you access to each of the resources.
+
+## 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.
+
+### Orders
+
+```ruby
+client.orders.list
+client.orders.create({})
+client.orders.retrieve(prodigi_order_id: "id")
+client.orders.actions
+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", {})
+```
+
+### Quotes
+
+```ruby
+client.quotes.create({})
+```
+
+### Products 
+
+```ruby
+client.products.create({})
+```
+
+## Contributing
+
+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/vultr.rb. Additionally, write a spec and add it to the list in the README.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "prodigi"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+client = Prodigi::Client.new(api_key: ENV["PRODIGI_API_KEY"])
+# client.connection.get("orders", {}, { "X-API-Key": client.api_key })
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/prodigi/client.rb

@@ -0,0 +1,36 @@
+module Prodigi
+  class Client 
+    BASE_URL = ENV.fetch('PRODIGI_API_URL',"https://api.sandbox.prodigi.com/v4.0")
+
+    attr_reader :api_key, :adapter
+
+    def initialize(api_key:, adapter: Faraday.default_adapter, stubs: nil)
+      @api_key = api_key
+      @adapter = adapter
+
+      # Tests stubs for requests
+      @stubs = stubs
+    end
+
+    def orders
+      OrderResource.new(self)
+    end
+
+    def quotes
+      QuoteResource.new(self)
+    end
+
+    def products
+      ProductResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new do |conn|
+        conn.url_prefix = BASE_URL
+        conn.request :json
+        conn.response :json, content_type: "application/json"
+        conn.adapter adapter, @stubs
+      end
+    end
+  end
+end

data/lib/prodigi/collection.rb

@@ -0,0 +1,20 @@
+module Prodigi
+  class Collection
+    attr_reader :data, :has_more, :next_url
+
+    def self.from_response(response, key:, type:)
+      body = response.body
+      new(
+        data: body[key].map { |attrs| type.new(attrs) },
+        has_more: body.dig("hasMore"),
+        next_url: body.dig("nextUrl")
+      )
+    end
+
+    def initialize(data:, has_more:, next_url:)
+      @data = data
+      @has_more = has_more
+      if @has_more == true; @next_url = next_url else @next_url = nil end
+    end
+  end
+end

data/lib/prodigi/error.rb

@@ -0,0 +1,4 @@
+module Prodigi
+  class Error < StandardError
+  end
+end

data/lib/prodigi/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module Prodigi
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/prodigi/objects/order.rb

@@ -0,0 +1,4 @@
+module Prodigi
+  class Order < Object
+  end
+end

data/lib/prodigi/objects/product.rb

@@ -0,0 +1,4 @@
+module Prodigi
+  class Product < Object
+  end
+end

data/lib/prodigi/objects/quote.rb

@@ -0,0 +1,4 @@
+module Prodigi
+  class Quote < Object
+  end
+end

data/lib/prodigi/resource.rb

@@ -0,0 +1,53 @@
+module Prodigi
+  class Resource
+    attr_reader :client
+
+    def initialize(client) 
+      @client = client
+    end
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, default_headers.merge(headers))
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, default_headers.merge(headers))
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, default_headers.merge(headers))
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, default_headers.merge(headers))
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, default_headers.merge(headers))
+    end
+
+    def default_headers
+      { "X-API-Key": client.api_key }
+    end
+
+    def handle_response(response)
+      message = response.body["statusText"]
+      case response.status
+      when 400
+        raise Error, "Bad request: the request is malformed in some manner. #{message}"
+      when 401
+        raise Error, "Unauthorised: your credentials are missing or incorrect. #{message}"
+      when 403
+        raise Error, message
+      when 404
+        raise Error, "Not found: the resource does not exist (or does not exist in your account). #{message}"
+      when 429
+        raise Error, message
+      when 500
+        raise Error, "Internal server error: Please contact support@prodigi.com. #{message}"
+      end
+
+      response
+    end
+  end
+end

data/lib/prodigi/resources/orders.rb

@@ -0,0 +1,61 @@
+module Prodigi
+  class OrderResource < Resource
+
+    def list(**params)
+      response = get_request("orders", params: params)
+      Collection.from_response(response, key: "orders", type: Order)
+    end
+
+    def create(**attributes)
+      response = post_request("orders", body: attributes)
+      if response.body.dig("outcome") == "Created"
+        Order.new response.body.dig("order")
+      end
+    end
+
+    def retrieve(prodigi_order_id:)
+      response = get_request("orders/#{prodigi_order_id}")
+      if response.body.dig("outcome") == "Ok"
+        Order.new response.body.dig("order")
+      end
+    end
+
+    def actions(prodigi_order_id:)
+      response = get_request("orders/#{prodigi_order_id}/actions")
+      if response.body.dig("outcome") == "Ok"
+        Object.new response.body
+      end
+    end
+
+    def update_shipping(prodigi_order_id:, **attributes)
+      response = post_request("orders/#{prodigi_order_id}/actions/updateShipping",
+                              body: attributes)
+      if response.body.dig("outcome") == "Updated"
+        Order.new response.body.dig("order")
+      end
+    end 
+
+    def update_recipient(prodigi_order_id:, **attributes)
+      response = post_request("orders/#{prodigi_order_id}/actions/updateRecipient",
+                              body: attributes)
+      if response.body.dig("outcome") == "Updated"
+        Order.new response.body.dig("order")
+      end
+    end 
+
+    def update_metadata(prodigi_order_id:, **attributes)
+      response = post_request("orders/#{prodigi_order_id}/actions/updateMetadata", body: attributes)
+      if response.body.dig("outcome") == "Updated"
+        Order.new response.body.dig("order")
+      end
+    end 
+
+    def cancel(prodigi_order_id:, **attributes)
+      response = post_request("orders/#{prodigi_order_id}/actions/cancel", 
+                              body: attributes)
+      if response.body.dig('outcome') == "Cancelled"
+        Order.new response.body.dig('order')
+      end
+    end 
+  end
+end

data/lib/prodigi/resources/products.rb

@@ -0,0 +1,12 @@
+module Prodigi
+  class ProductResource < Resource
+
+    def details(sku:)
+      response = get_request("products/#{sku}")
+      if response.body.dig("outcome") == "Ok"
+        Product.new response.body.dig("product")
+      end
+    end
+
+  end
+end

data/lib/prodigi/resources/quotes.rb

@@ -0,0 +1,12 @@
+module Prodigi
+  class QuoteResource < Resource
+
+    def create(**attributes)
+      response = post_request("quotes", body: attributes)
+      if response.body.dig("outcome") == "Created"
+        Quote.new response.body
+      end
+    end
+
+  end
+end

data/lib/prodigi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Prodigi
+  VERSION = "0.1.1"
+end

data/lib/prodigi.rb

@@ -0,0 +1,21 @@
+require "faraday"
+require "faraday_middleware"
+require_relative "prodigi/version"
+
+module Prodigi
+  autoload :Client, "prodigi/client"
+  autoload :Collection, "prodigi/collection"
+  autoload :Error, "prodigi/error"
+  autoload :Resource, "prodigi/resource"
+  autoload :Object, "prodigi/object"
+
+  # High-level categories of Prodigi API calls
+  autoload :OrderResource, "prodigi/resources/orders"
+  autoload :QuoteResource, "prodigi/resources/quotes"
+  autoload :ProductResource, "prodigi/resources/products"
+
+  # Classes used to return a nicer object wrapping the response data
+  autoload :Order, "prodigi/objects/order"
+  autoload :Quote, "prodigi/objects/quote"
+  autoload :Product, "prodigi/objects/product"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: prodigi
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Robin Clark
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Ruby bindings for the Prodigi API. Prodigi API can be found here https://www.prodigi.com/print-api
+email:
+- robindtclark@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/prodigi.rb
+- lib/prodigi/.client.rb.swp
+- lib/prodigi/client.rb
+- lib/prodigi/collection.rb
+- lib/prodigi/error.rb
+- lib/prodigi/object.rb
+- lib/prodigi/objects/order.rb
+- lib/prodigi/objects/product.rb
+- lib/prodigi/objects/quote.rb
+- lib/prodigi/resource.rb
+- lib/prodigi/resources/orders.rb
+- lib/prodigi/resources/products.rb
+- lib/prodigi/resources/quotes.rb
+- lib/prodigi/version.rb
+homepage: https://github.com/rdtclark/prodigi.rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rdtclark/prodigi.rb
+  source_code_uri: https://github.com/rdtclark/prodigi.rb
+  changelog_uri: https://github.com/rdtclark/prodigi/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Ruby bindings for Prodigi API
+test_files: []