zinc-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17e2df35b414b9cd6d7e9020b3540638d208acdd
+  data.tar.gz: 731065cd9ed01a6435b027cf8cd705e444a795fc
+SHA512:
+  metadata.gz: d8b3808422e089a9ddb4213904cd11e079b887adee93eec6a7aa5ee357e4a820ac8672a77d585174fabb53284b360d0f841e21c0493824ed64f986979bc0ef30
+  data.tar.gz: 4b0ab1ab71c019dbe530588436a86e87c0e8840e751c3aa413be3b07dde6d84dd2323359396620f6eab15457056be0bdd0d8a296378e7dff680e3eedfb4def8d

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+/Gemfile.lock
+/.approvals
+/.bundle
+/coverage
+.DS_Store
+
+/.api_path
+/.access_token

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+
+Lint/EndAlignment:
+  Enabled: false
+
+Layout/IndentationWidth:
+  Enabled: false
+Layout/ElseAlignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+ - 2.2
+# branches:
+#   only:
+#     - master
+script:
+  - bundle exec rubocop
+  - bundle exec rake
+cache: bundler

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development, :test do
+  gem 'awesome_print'
+  gem 'pry'
+  gem 'rake'
+  gem 'rubocop', '0.49.0'
+end
+
+group :test do
+  gem 'coveralls', require: false
+  gem 'rspec'
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tophatter
+
+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,49 @@
+### Zinc API
+Full documentation is available [here](https://docs.zincapi.com/).
+
+### Installation
+```ruby
+gem 'zinc-api'
+```
+
+### Usage
+```ruby
+Zinc::Order.create(
+  retailer: 'amazon',
+  retailer_credentials: Zinc::RetailerCredentials.new(
+    'email' => 'foo@bar.com',
+    'password' => 'jabberwocky'
+  ),
+  products: [Zinc::Product.new('product_id' => 'B06XGHJ5H3', 'quantity' => 1)],
+  payment_method: Zinc::PaymentMethod.new(
+    'name_on_card' => 'Foo Bar',
+    'number' => '4242424242424242',
+    'security_code' => '123',
+    'expiration_month' => 1,
+    'expiration_year' => 2020
+  ),
+  billing_address: Zinc::Address.new(
+    'first_name' => 'Jane',
+    'last_name' => 'Doe',
+    'address_line1' => '185 Berry St',
+    'address_line2' => 'Suite 2400 ',
+    'zip_code' => '94107',
+    'city' => 'San Francisco',
+    'state' => 'CA',
+    'country' => 'US',
+    'phone_number' => '1231231234'
+  ),
+  shipping_address: Zinc::Address.new(
+    'first_name' => 'Jane',
+    'last_name' => 'Doe',
+    'address_line1' => '185 Berry St',
+    'address_line2' => 'Suite 2400 ',
+    'zip_code' => '94107',
+    'city' => 'San Francisco',
+    'state' => 'CA',
+    'country' => 'US',
+    'phone_number' => '1231231234'
+  ),
+  shipping: Zinc::Shipping.new('order_by' => 'price', 'max_days' => 5, 'max_price' => 1000)
+)
+```

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/bin/console

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rest-client'
+require 'zinc'
+
+begin
+  Zinc.api_path = File.read('.api_path').chomp
+  puts "Zinc.api_path: #{Zinc.api_path}"
+rescue Errno::ENOENT
+  puts "No .api_path file, using default: #{Zinc.api_path}"
+end
+
+begin
+  Zinc.access_token = File.read('.access_token').chomp
+  puts "Zinc.access_token: #{Zinc.access_token}"
+rescue Errno::ENOENT
+  puts "No .access_token file - you'll have to set Zinc.access_token manually from the console."
+end
+
+Zinc.logger.level = Logger::DEBUG
+
+require 'awesome_print'
+require 'pry'
+
+AwesomePrint.pry!
+Pry.start

data/lib/zinc.rb

@@ -0,0 +1,24 @@
+require 'json'
+
+module Zinc
+  class << self
+    attr_accessor :api_path, :access_token, :logger
+
+    def api_path
+      @api_path || 'https://api.zinc.io/v1'
+    end
+
+    def logger
+      unless defined?(@logger)
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger::WARN
+      end
+
+      @logger
+    end
+  end
+end
+
+%w(model resource account_status address merchant_order_id order payment_method price_components product retailer_credentials seller_selection_criteria shipping tracking).each do |file|
+  require File.dirname(__FILE__) + "/zinc/#{file}"
+end

data/lib/zinc/account_status.rb

@@ -0,0 +1,8 @@
+module Zinc
+  class AccountStatus < Model
+    attr_accessor :prime,
+                  :fresh,
+                  :business,
+                  :charity
+  end
+end

data/lib/zinc/address.rb

@@ -0,0 +1,13 @@
+module Zinc
+  class Address < Model
+    attr_accessor :first_name,
+                  :last_name,
+                  :address_line1,
+                  :address_line2,
+                  :zip_code,
+                  :city,
+                  :state,
+                  :country,
+                  :phone_number
+  end
+end

data/lib/zinc/merchant_order_id.rb

@@ -0,0 +1,12 @@
+module Zinc
+  class MerchantOrderId < Model
+    attr_accessor :merchant_order_id,
+                  :merchant,
+                  :account,
+                  :placed_at,
+                  :tracking,
+                  :product_ids,
+                  :tracking_url,
+                  :delivery_date
+  end
+end

data/lib/zinc/model.rb

@@ -0,0 +1,38 @@
+module Zinc
+  class Model
+    def initialize(hash, exclude: {})
+      hash.each do |key, value|
+        if exclude.include?(key)
+          next
+        end
+
+        if respond_to?("#{key}=")
+          send("#{key}=", value)
+        else
+          Zinc.logger.warn "Invalid attribute #{key} specified for #{self.class.name}"
+        end
+      end
+    end
+
+    def to_hash
+      instance_variables.map do |instance_variable|
+        key   = instance_variable_name(instance_variable)
+        value = instance_variable_get(instance_variable)
+
+        if value.is_a?(Array) && value.all? { |element| element.respond_to?(:to_hash) }
+          value = value.map(&:to_hash)
+        elsif value.respond_to?(:to_hash)
+          value = value.to_hash
+        end
+
+        value ? [key, value] : nil
+      end.compact.to_h
+    end
+
+    private
+
+    def instance_variable_name(instance_variable)
+      instance_variable.to_s.delete('@')
+    end
+  end
+end

data/lib/zinc/order.rb

@@ -0,0 +1,79 @@
+module Zinc
+  class Order < Resource
+    attr_accessor :request_id,
+                  :_type,
+                  :code,
+                  :message,
+                  :status_updates,
+                  :error,
+                  :price_components, # A Zinc::PriceComponent object.
+                  :merchant_order_ids, # Array of Zinc::MerchantOrderId objects.
+                  :tracking, # Array of Zinc::Tracking objects.
+                  :request, # ?
+                  :delivery_dates, # ?
+                  :account_status # A Zinc::AccountStatus object.
+
+    def initialize(hash)
+      @request_id         = hash['request_id'] if hash['request_id']
+      @_type              = hash['_type'] if hash['_type']
+      @code               = hash['code'] if hash['code']
+      @message            = hash['message'] if hash['message']
+      @status_updates     = hash['status_updates'] if hash['status_updates']
+      @error              = hash['error'] if hash['error']
+      @price_components   = PriceComponents.new(hash['price_components']) if hash['price_components']
+      @merchant_order_ids = hash['merchant_order_ids'].map { |hash| MerchantOrderId.new(hash) } if hash['merchant_order_ids']
+      @tracking           = hash['tracking'].map { |hash| Tracking.new(hash) } if hash['tracking']
+      @request            = hash['request'] if hash['request']
+      @delivery_dates     = hash['delivery_dates'] if hash['delivery_dates']
+      @account_status     = AccountStatus.new(hash['account_status']) if hash['account_status']
+    end
+
+    class << self
+      def all(offset: 0, limit: 20)
+        response = get(path: 'orders', params: { offset: offset, limit: limit })
+        response['orders'].map { |hash| Order.new(hash) }
+      end
+
+      def retrieve(request_id)
+        response = get(path: "orders/#{request_id}")
+        Order.new(response)
+      end
+
+      def create(retailer:, retailer_credentials:, products:, payment_method:, billing_address:, shipping_address:, shipping:, options: {})
+        params = {
+          retailer: retailer,
+          retailer_credentials: retailer_credentials.to_hash,
+          products: products.map(&:to_hash),
+          payment_method: payment_method.to_hash,
+          billing_address: billing_address.to_hash,
+          shipping_address: shipping_address.to_hash,
+          shipping: shipping.to_hash
+        }
+
+        # Valid options:
+        #  - is_gift
+        #  - gift_message
+        #  - max_price
+        #  - webhooks
+        #  - client_notes
+        #  - promo_codes
+        #  - po_number
+        #  - bundled
+        params.merge!(options) unless params.empty?
+
+        response = post(path: 'orders', params: params)
+        Order.new(response)
+      end
+
+      def abort(request_id)
+        response = post(path: "orders/#{request_id}/abort")
+        Order.new(response)
+      end
+
+      def cancel(request_id)
+        response = post(path: "orders/#{request_id}/cancel")
+        Order.new(response)
+      end
+    end
+  end
+end

data/lib/zinc/payment_method.rb

@@ -0,0 +1,10 @@
+module Zinc
+  class PaymentMethod < Model
+    attr_accessor :name_on_card,
+                  :number,
+                  :security_code,
+                  :expiration_month,
+                  :expiration_year,
+                  :use_gift
+  end
+end

data/lib/zinc/price_components.rb

@@ -0,0 +1,10 @@
+module Zinc
+  class PriceComponents < Model
+    attr_accessor :shipping,
+                  :product_subtotals,
+                  :subtotal,
+                  :tax,
+                  :total,
+                  :gift_certificate
+  end
+end

data/lib/zinc/product.rb

@@ -0,0 +1,12 @@
+module Zinc
+  class Product < Model
+    attr_accessor :product_id,
+                  :quantity,
+                  :seller_selection_criteria
+
+    def initialize(hash)
+      super(hash, exclude: %w(seller_selection_criteria))
+      @seller_selection_criteria = SellerSelectionCriteria.new(hash['seller_selection_criteria']) if hash['seller_selection_criteria']
+    end
+  end
+end

data/lib/zinc/resource.rb

@@ -0,0 +1,53 @@
+module Zinc
+  class Resource < Model
+    class << self
+      protected
+
+      def get(path:, params: {})
+        Zinc.logger.debug url(path, params)
+        response = RestClient::Request.new(
+          method: :get,
+          url: url(path, params),
+          user: Zinc.access_token,
+          headers: headers
+        ).execute
+        # Zinc.logger.debug response.headers.inspect
+        Zinc.logger.debug response.code
+        Zinc.logger.debug response.body
+        JSON.parse(response.body)
+      end
+
+      def post(path:, params: {})
+        Zinc.logger.debug url(path)
+        Zinc.logger.debug params.to_json
+        response = RestClient::Request.new(
+          method: :post,
+          url: url(path),
+          user: Zinc.access_token,
+          payload: params.to_json,
+          headers: headers
+        ).execute
+        # Zinc.logger.debug response.headers.inspect
+        Zinc.logger.debug response.code
+        Zinc.logger.debug response.body
+        JSON.parse(response.body)
+      end
+
+      private
+
+      def url(path, params = {})
+        url = "#{Zinc.api_path}/#{path}"
+        url += "?#{URI.encode_www_form(params)}" unless params.empty?
+        url
+      end
+
+      def headers
+        {
+          accept: :json,
+          content_type: :json,
+          user_agent: 'Zinc API [Ruby] (https://github.com/tophatter/zinc-api)'
+        }
+      end
+    end
+  end
+end

data/lib/zinc/retailer_credentials.rb

@@ -0,0 +1,8 @@
+module Zinc
+  class RetailerCredentials < Model
+    attr_accessor :email,
+                  :password,
+                  :verification_code,
+                  :totp_2fa_key
+  end
+end

data/lib/zinc/seller_selection_criteria.rb

@@ -0,0 +1,7 @@
+module Zinc
+  class SellerSelectionCriteria < Model
+    attr_accessor :prime,
+                  :handling_days_max,
+                  :condition_in
+  end
+end

data/lib/zinc/shipping.rb

@@ -0,0 +1,7 @@
+module Zinc
+  class Shipping < Model
+    attr_accessor :order_by,
+                  :max_days,
+                  :max_price
+  end
+end

data/lib/zinc/tracking.rb

@@ -0,0 +1,10 @@
+module Zinc
+  class Tracking < Model
+    attr_accessor :merchant_order_id,
+                  :carrier,
+                  :tracking_number,
+                  :tracking_url,
+                  :product_id,
+                  :obtained_at
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'rest-client'
+require 'awesome_print'
+require 'zinc'

data/spec/zinc/order_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+# rspec spec/zinc/order_spec.rb
+describe Zinc::Order do
+  let(:request_id) { 'abc123'}
+  let(:retailer) { 'amazon' }
+  let(:retailer_credentials) { Zinc::RetailerCredentials.new('email' => 'foo@bar.com', 'password' => 'jabberwocky') }
+  let(:product) { Zinc::Product.new('product_id' => 'B06XGHJ5H3', 'quantity' => 1, 'seller_selection_criteria' => { 'prime' => true, 'handling_days_max' => 6, 'condition_in' => ['New'] }) }
+  let(:payment_method) { Zinc::PaymentMethod.new('name_on_card' => 'Foo Bar', 'number' => '4242424242424242', 'security_code' => '123', 'expiration_month' => 1, 'expiration_year' => 2020) }
+  let(:address) { Zinc::Address.new('first_name' => 'Jane', 'last_name' => 'Doe', 'address_line1' => '185 Berry St', 'address_line2' => 'Suite 2400 ', 'zip_code' => '94107', 'city' => 'San Francisco', 'state' => 'CA', 'country' => 'US', 'phone_number' => '1231231234') }
+  let(:shipping) { Zinc::Shipping.new('order_by' => 'price', 'max_days' => 5, 'max_price' => 1000) }
+
+  let(:create_response) do
+    {
+      'request_id' => request_id
+    }
+  end
+
+  let(:retrieve_response) do
+    {
+      '_type' => 'order_response',
+      'price_components' => { 'shipping' => 0, 'subtotal' => 1999, 'tax' => 0, 'total' => 1999 },
+      'merchant_order_ids' => [{ 'merchant_order_id' => '112-1234567-7272727', 'merchant' => 'amazon', 'account' => 'foo@bar.com', 'placed_at' => '2017-07-02T23:51:08.366Z' }],
+      'tracking' => [{ 'product_id' => '0923568964', 'merchant_order_id' => '112-1234567-7272727', 'carrier' => 'Fedex', 'tracking_number' => '9261290100129790891234', 'obtained_at' => '2017-07-03T23:22:48.165Z' }],
+      'request' => {},
+      'account_status' => { 'prime' => true, 'fresh' => false, 'business' => true }
+    }
+  end
+
+  describe '.create' do
+    it 'creates a new order' do
+      expect(Zinc::Order).to receive(:post).and_return(create_response)
+
+      order = Zinc::Order.create(
+        retailer: retailer,
+        retailer_credentials: retailer_credentials,
+        products: [product],
+        payment_method: payment_method,
+        billing_address: address,
+        shipping_address: address,
+        shipping: shipping
+      )
+
+      expect(order.request_id).to eq(request_id)
+    end
+  end
+
+  describe '#retrieve' do
+    it 'fetches an existing order' do
+      expect(Zinc::Order).to receive(:get).with(path: "orders/#{request_id}").and_return(retrieve_response)
+      order = Zinc::Order.retrieve(request_id)
+      expect(order.tracking[0].product_id).to eq('0923568964')
+    end
+  end
+
+  describe '#to_hash' do
+    let(:order) { Zinc::Order.new(retrieve_response) }
+
+    it 'serializes the object to a hash' do
+      hash = order.to_hash
+      expect(hash['tracking'][0]['product_id']).to eq('0923568964')
+    end
+  end
+end

data/zinc.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+# To publish the next version:
+# gem build zinc-api.gemspec
+# gem push zinc-api-{VERSION}.gem
+Gem::Specification.new do |s|
+  s.name        = 'zinc-api'
+  s.version     = '0.0.1'
+  s.platform    = Gem::Platform::RUBY
+  s.licenses    = ['MIT']
+  s.authors     = ['Chris Estreich']
+  s.email       = ['chris@tophatter.com']
+  s.homepage    = 'https://github.com/tophatter/zinc-api-ruby'
+  s.summary     = 'Ruby bindings for the Zinc API.'
+  s.description = 'Ruby bindings for the Zinc API.'
+
+  s.extra_rdoc_files = ['README.md']
+
+  s.required_ruby_version = '~> 2.0'
+
+  s.add_dependency 'rest-client', '~> 1.6'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: zinc-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Estreich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Ruby bindings for the Zinc API.
+email:
+- chris@tophatter.com
+executables:
+- console
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- lib/zinc.rb
+- lib/zinc/account_status.rb
+- lib/zinc/address.rb
+- lib/zinc/merchant_order_id.rb
+- lib/zinc/model.rb
+- lib/zinc/order.rb
+- lib/zinc/payment_method.rb
+- lib/zinc/price_components.rb
+- lib/zinc/product.rb
+- lib/zinc/resource.rb
+- lib/zinc/retailer_credentials.rb
+- lib/zinc/seller_selection_criteria.rb
+- lib/zinc/shipping.rb
+- lib/zinc/tracking.rb
+- spec/spec_helper.rb
+- spec/zinc/order_spec.rb
+- zinc.gemspec
+homepage: https://github.com/tophatter/zinc-api-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the Zinc API.
+test_files:
+- spec/spec_helper.rb
+- spec/zinc/order_spec.rb