tophatter-merchant 1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8de1362487600774b5ef62b300902aa00bcbd078
-  data.tar.gz: d43f56863dc7cf280b01a85c0a5b4a3fb7de54d6
+  metadata.gz: 75730e4724f4e6b9227197c0dada5fa3a273118e
+  data.tar.gz: aa6621873c6c3592aa39092166b92204de4bf4d0
 SHA512:
-  metadata.gz: ceacd0c967b71400e9c001b6979a804f1f92b4ca18d236fc130c12c24eaac066f6220fe702e902c1de2ccc984d97301c91e7b6586a8422c9f1cfad292b7f0967
-  data.tar.gz: 3d077e9be766d053332a4708bcfe29b78b4c9398000dbd08fa23b82a6ae55f4f0f3433a7c3234caadbcc52425a588993060185191a0c73c562fa2e8949edc1b3
+  metadata.gz: 6b414c775476118e1776c34e1b9eb57d70e73f3c8a94ba49c783d08bd2a65e085a2d3e99b9efa00f522ce3a0af7a124b4b115fb669a59e415be68a15996b3d2d
+  data.tar.gz: f616055d289707ca5d633cc624312acf73d66c9c16ad19c9d291d63001398a5d2c0dfb0dcc1b42a1e7ac0036229f6dc62db49018fac884906a9a8091168116b4

data/.gitignore

@@ -5,3 +5,4 @@ Gemfile.lock
 .idea
 .api_path
 .access_token
+*.gem

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+# [Metrics]
+
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+# Complexity metrics are difficult to understand and fix, so let's ignore them.
+Metrics/AbcSize:
+  Enabled: false
+
+# [Lint]
+
+# http://www.rubydoc.info/github/bbatsov/rubocop/Rubocop/Cop/Lint/EndAlignment
+Lint/EndAlignment:
+  Enabled: false
+
+# [Style]
+
+# http://www.rubydoc.info/github/bbatsov/rubocop/Rubocop/Cop/Style/Documentation
+Style/Documentation:
+  Enabled: false
+# http://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/ElseAlignment
+Style/ElseAlignment:
+  Enabled: false
+# http://www.rubydoc.info/github/bbatsov/rubocop/Rubocop/Cop/Style/IndentationWidth
+Style/IndentationWidth:
+  Enabled: false

data/LICENSE

@@ -1,6 +1,6 @@
-The MIT License
+The MIT License (MIT)
 
-Copyright (c) 2016 Tophatter, Inc
+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
@@ -9,13 +9,13 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,6 +1,11 @@
 ### Tophatter Merchant API
 Full documentation is available [here](https://tophatter.readme.io/v1/docs).
 
+### Installation
+```ruby
+gem 'tophatter-merchant', require: 'tophatter_merchant'
+```
+
 ### Console Testing (Development)
 ```bash
 echo http://tophatter.dev/merchant_api/v1 > .api_host

data/VERSION

@@ -1 +1 @@
-1.0
+1.1.1

data/bin/console

@@ -8,16 +8,19 @@ require 'pry'
 
 begin
   TophatterMerchant.api_path = File.read('.api_path').chomp
+  puts "TophatterMerchant.api_path: #{TophatterMerchant.api_path}"
 rescue Errno::ENOENT
+  puts "No .api_path file, using default: #{TophatterMerchant.api_path}"
 end
 
 begin
   TophatterMerchant.access_token = File.read('.access_token').chomp
+  puts "TophatterMerchant.access_token: #{TophatterMerchant.access_token}"
 rescue Errno::ENOENT
+  puts "No .access_token file - you'll have to set TophatterMerchant.access_token manually from the console."
 end
 
-puts "TophatterMerchant.api_path: #{TophatterMerchant.api_path}"
-puts "TophatterMerchant.access_token: #{TophatterMerchant.access_token}"
+TophatterMerchant.logger.level = Logger::DEBUG
 
 Pry.config.color = false
 Pry.start

data/lib/tophatter_merchant.rb

@@ -1,5 +1,24 @@
 require 'active_model'
 
+module TophatterMerchant
+  class << self
+    attr_accessor :api_path, :access_token, :logger
+
+    def api_path
+      @api_path || 'https://tophatter.com/merchant_api/v1'
+    end
+
+    def logger
+      unless defined?(@logger)
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger::WARN
+      end
+
+      @logger
+    end
+  end
+end
+
 require File.dirname(__FILE__) + '/tophatter_merchant/version'
 require File.dirname(__FILE__) + '/tophatter_merchant/exceptions'
 
@@ -12,23 +31,3 @@ require File.dirname(__FILE__) + '/tophatter_merchant/metadata'
 require File.dirname(__FILE__) + '/tophatter_merchant/order'
 require File.dirname(__FILE__) + '/tophatter_merchant/product'
 require File.dirname(__FILE__) + '/tophatter_merchant/variation'
-
-module TophatterMerchant
-
-  def self.access_token
-    defined?(@@access_token) ? @@access_token : nil
-  end
-
-  def self.access_token=(token)
-    @@access_token = token
-  end
-
-  def self.api_path
-    defined?(@@api_path) ? @@api_path : 'https://tophatter.com/merchant_api/v1'
-  end
-
-  def self.api_path=(path)
-    @@api_path = path
-  end
-
-end

data/lib/tophatter_merchant/account.rb

@@ -1,6 +1,5 @@
 module TophatterMerchant
   class Account < Resource
-
     attr_accessor :access_token, :first_name, :last_name, :store_name, :email, :country, :time_zone
 
     def id
@@ -8,7 +7,6 @@ module TophatterMerchant
     end
 
     class << self
-
       # ap TophatterMerchant::Account.schema
       def schema
         get(url: "#{path}/schema.json")
@@ -16,10 +14,7 @@ module TophatterMerchant
 
       # ap TophatterMerchant::Account.authenticate(email: 'megatron@autobot.com', password: 'ipipip').to_h
       def authenticate(email:, password:)
-        Account.new post(url: "#{path}/authenticate.json", params: {
-          email: email,
-          password: password
-        })
+        Account.new post(url: "#{path}/authenticate.json", params: { email: email, password: password })
       end
 
       # ap TophatterMerchant::Account.me.to_h
@@ -47,7 +42,6 @@ module TophatterMerchant
       def path
         super + '/account'
       end
-
     end
   end
 end

data/lib/tophatter_merchant/api_key.rb

@@ -1,10 +1,8 @@
 module TophatterMerchant
   class ApiKey < Resource
-
     attr_accessor :id, :access_token, :created_at
 
     class << self
-
       # ap TophatterMerchant::ApiKey.schema
       def schema
         get(url: "#{path}/schema.json")
@@ -39,7 +37,6 @@ module TophatterMerchant
       def path
         super + '/api_keys'
       end
-
     end
   end
 end

data/lib/tophatter_merchant/image.rb

@@ -1,10 +1,8 @@
 module TophatterMerchant
   class Image < Resource
-
     attr_accessor :id, :fingerprint, :url
 
     class << self
-
       # request = RestClient::Request.new(method: :get, url: 'https://img0.etsystatic.com/101/0/7856452/il_fullxfull.882030160_r0tn.jpg')
       # response = request.execute
       # File.open('/tmp/foo.jpg', 'w') { |file| file.write(response.body) }
@@ -18,7 +16,6 @@ module TophatterMerchant
       def path
         super + '/images'
       end
-
     end
   end
 end

data/lib/tophatter_merchant/metadata.rb

@@ -1,7 +1,6 @@
 module TophatterMerchant
   class Metadata < Resource
     class << self
-
       # ap TophatterMerchant::Metadata.all
       def all
         get(url: "#{path}.json")
@@ -70,7 +69,6 @@ module TophatterMerchant
       def path
         super + '/metadata'
       end
-
     end
   end
 end

data/lib/tophatter_merchant/order.rb

@@ -1,16 +1,16 @@
 module TophatterMerchant
   class Order < Resource
-
-    attr_accessor :order_id, :status
-    attr_accessor :carrier, :tracking_number
-    attr_accessor :product_name, :product_identifier, :variation_identifier
-    attr_accessor :customer_name, :address1, :address2, :city, :state, :postal_code, :country
-    attr_accessor :available_refunds, :refund_amount
-    attr_accessor :disbursement_amount, :seller_fees_amount, :seller_fees
-    attr_accessor :paid_at, :created_at
+    attr_accessor :order_id, :status,
+                  :carrier, :tracking_number,
+                  :product_name, :product_identifier, :variation_identifier,
+                  :customer_id, :customer_name,
+                  :address1, :address2, :city, :state, :postal_code, :country,
+                  :available_refunds, :refund_amount,
+                  :disbursement_amount, :seller_fees_amount, :seller_fees,
+                  :paid_at, :created_at,
+                  :ca_acknowledged # @FIXME: This shouldn't be here.
 
     class << self
-
       # ap TophatterMerchant::Order.schema
       def schema
         get(url: "#{path}/schema.json")
@@ -27,18 +27,12 @@ module TophatterMerchant
 
       # ap TophatterMerchant::Order.retrieve(681195262).to_h
       def retrieve(id)
-        Order.new get(url: "#{path}/retrieve.json", params: {
-          order_id: id
-        })
+        Order.new get(url: "#{path}/retrieve.json", params: { order_id: id })
       end
 
       # ap TophatterMerchant::Order.fulfill(417953232, carrier: 'other', tracking_number: 'ABC123').to_h
       def fulfill(id, carrier:, tracking_number:)
-        Order.new post(url: "#{path}/fulfill.json", params: {
-          order_id: id,
-          carrier: carrier,
-          tracking_number: tracking_number
-        })
+        Order.new post(url: "#{path}/fulfill.json", params: { order_id: id, carrier: carrier, tracking_number: tracking_number })
       end
 
       def unfulfill(id)
@@ -48,12 +42,7 @@ module TophatterMerchant
       # ap TophatterMerchant::Order.refund(417953232, type: 'full', reason: 'delay_in_shipping').to_h
       # ap TophatterMerchant::Order.refund(417953232, type: 'partial', reason: 'other', fees: ['shipping_fee']).to_h
       def refund(id, type:, reason:, fees: [])
-        Order.new post(url: "#{path}/refund.json", params: {
-          order_id: id,
-          type: type,
-          reason: reason,
-          fees: fees
-        })
+        Order.new post(url: "#{path}/refund.json", params: { order_id: id, type: type, reason: reason, fees: fees })
       end
 
       protected
@@ -61,7 +50,6 @@ module TophatterMerchant
       def path
         super + '/orders'
       end
-
     end
   end
 end

data/lib/tophatter_merchant/product.rb

@@ -1,17 +1,16 @@
 module TophatterMerchant
   class Product < Resource
-
-    attr_accessor :identifier
-    attr_accessor :category, :title, :description # Basics
-    attr_accessor :condition, :brand, :material # Facets
-    attr_accessor :available_quantity, :variations # Variations
-    attr_accessor :starting_bid, :buy_now_price, :retail_price, :cost_basis, :minimum_alerts_needed # Pricing
-    attr_accessor :shipping_origin, :shipping_price, :expedited_shipping_price, :days_to_fulfill, :days_to_deliver, :expedited_days_to_deliver, :weight # Shipping
-    attr_accessor :buy_one_get_one_price, :accessory_price, :accessory_description # Upsells
-    attr_accessor :primary_image, :extra_images, :all_images # Images
-    attr_accessor :slug, :ratings_average, :ratings_count # Ratings
-    attr_accessor :created_at, :updated_at, :disabled_at, :deleted_at # Timestamps
-    attr_accessor :blacklisted_at, :admin_hold_at, :slug, :internal_id # Other
+    attr_accessor :identifier,
+                  :category, :title, :description, # Basics
+                  :condition, :brand, :material, # Facets
+                  :available_quantity, :variations, # Variations
+                  :starting_bid, :buy_now_price, :retail_price, :cost_basis, :minimum_alerts_needed, # Pricing
+                  :shipping_origin, :shipping_price, :expedited_shipping_price, :days_to_fulfill, :days_to_deliver, :expedited_days_to_deliver, :weight, # Shipping
+                  :buy_one_get_one_price, :accessory_price, :accessory_description, # Upsells
+                  :primary_image, :extra_images, :all_images, # Images
+                  :slug, :ratings_average, :ratings_count, # Ratings
+                  :created_at, :updated_at, :disabled_at, :deleted_at, # Timestamps
+                  :blacklisted_at, :admin_hold_at, :slug, :internal_id # Other
 
     def id
       created_at.present? ? identifier : nil
@@ -27,15 +26,15 @@ module TophatterMerchant
     end
 
     def copy
-      attributes = to_h
+      hash = to_h
 
-      # Delete the attributes that shouldn't be copied.
-      %w(identifier primary_image extra_images all_images ratings_average ratings_count created_at updated_at disabled_at deleted_at blacklisted_at slug admin_hold_at).each do |attribute|
-        attributes.delete(attribute)
-        attributes['variations'].each { |variation| variation.delete(attribute) }
+      # Delete the keys that shouldn't be copied.
+      %w(identifier primary_image extra_images all_images ratings_average ratings_count created_at updated_at disabled_at deleted_at blacklisted_at slug admin_hold_at).each do |key|
+        hash.delete(key)
+        hash['variations'].each { |variation| variation.delete(key) }
       end
 
-      Product.new(attributes)
+      Product.new(hash)
     end
 
     def to_param
@@ -43,19 +42,13 @@ module TophatterMerchant
     end
 
     class << self
-
       # ap TophatterMerchant::Product.schema
       def schema
         get(url: "#{path}/schema.json")
       end
 
       def search(query:, page: 1, per_page: 50, pagination: nil)
-        result = get(url: "#{path}/search.json", params: {
-          query: query,
-          page: page,
-          per_page: per_page,
-          pagination: pagination
-        })
+        result = get(url: "#{path}/search.json", params: { query: query, page: page, per_page: per_page, pagination: pagination })
 
         if pagination.present?
           result['results'] = result['results'].map { |hash| Product.new(hash) }
@@ -68,14 +61,7 @@ module TophatterMerchant
 
       # ap TophatterMerchant::Product.all.map(&:to_h)
       def all(status: nil, category: nil, page: 1, per_page: 50, pagination: nil, sort: nil)
-        result = get(url: "#{path}.json", params: {
-          status: status,
-          category: category,
-          page: page,
-          per_page: per_page,
-          pagination: pagination,
-          sort: sort
-        })
+        result = get(url: "#{path}.json", params: { status: status, category: category, page: page, per_page: per_page, pagination: pagination, sort: sort })
 
         if pagination.present?
           result['results'] = result['results'].map { |hash| Product.new(hash) }
@@ -124,7 +110,6 @@ module TophatterMerchant
       def path
         super + '/products'
       end
-
     end
   end
 end

data/lib/tophatter_merchant/resource.rb

@@ -2,48 +2,39 @@ require 'active_model'
 
 module TophatterMerchant
   class Resource
-
     include ActiveModel::Model
 
-    def self.attr_accessor(*vars)
-      attributes!(*vars)
-      super(*vars)
-    end
-
     def initialize(hash)
-      self.attributes = hash
-    end
-
-    def attributes=(hash)
+      # Only honor valid attributes.
       hash.each do |key, value|
-        if respond_to?(key)
-          self.class.attributes!(key)
+        if respond_to?("#{key}=")
           send("#{key}=", value)
+        else
+          TophatterMerchant.logger.warn "Invalid attribute #{key} specified for #{self.class.name}"
         end
       end
     end
 
-    def to_h
-      self.class.attributes.keys.collect { |key| [key, send(key)] }.to_h
-    end
-
     def persisted?
-      id.present?
+      id.present? # @TODO: Should this be internal_id?
     end
 
-    private
-
-    def self.attributes
-      @attributes || {}
-    end
-
-    def self.attributes!(*vars)
-      @attributes ||= {}
-      vars.map(&:to_s).each { |var| @attributes[var] = true }
-      @attributes
+    def to_h
+      self.class.attributes.map { |key| [key, send(key)] }.to_h
     end
 
     class << self
+      def attr_accessor(*vars)
+        # TophatterMerchant.logger.debug "#{name}: #{vars.inspect} (attr_accessor)"
+        @attributes ||= {}
+        vars.each { |var| @attributes[var.to_s] = true }
+        super(*vars)
+      end
+
+      def attributes
+        @attributes ||= {}
+        @attributes.keys
+      end
 
       protected
 
@@ -64,20 +55,22 @@ module TophatterMerchant
       end
 
       def execute(request)
-        begin
-          puts "#{request.method.upcase} #{request.url} #{request.payload.inspect}"
-          response = request.execute
-          raise BadContentTypeException.new, "The server didn't return JSON. You probably made a bad request." if response.headers[:content_type] == 'text/html; charset=utf-8'
-          JSON.parse(response.body)
-        rescue RestClient::Request::Unauthorized => e
-          raise UnauthorizedException.new, parse_error(e, e.message)
-        rescue RestClient::BadRequest => e
-          raise BadRequestException.new, parse_error(e, e.message)
-        rescue RestClient::ResourceNotFound => e
-          raise NotFoundException.new, parse_error(e, 'The API path you requested does not exist.')
-        rescue RestClient::InternalServerError => e
-          raise ServerErrorException.new, parse_error(e, 'The server encountered an internal error. This is probably a bug, and you should contact support.')
-        end
+        TophatterMerchant.logger.debug "#{request.method.upcase} #{request.url} #{request.payload.inspect}"
+        response = request.execute
+        raise BadContentTypeException.new, "The server didn't return JSON. You probably made a bad request." if response.headers[:content_type] == 'text/html; charset=utf-8'
+        JSON.parse(response.body)
+      rescue RestClient::Request::Unauthorized, RestClient::Forbidden => e
+        TophatterMerchant.logger.debug "#{e.class.name}: #{e.response.code} -> raising UnauthorizedException"
+        raise UnauthorizedException.new, parse_error(e, e.message)
+      rescue RestClient::ResourceNotFound => e
+        TophatterMerchant.logger.debug "#{e.class.name}: #{e.response.code} -> raising NotFoundException"
+        raise NotFoundException.new, parse_error(e, 'The API path you requested does not exist.')
+      rescue RestClient::BadRequest => e
+        TophatterMerchant.logger.debug "#{e.class.name}: #{e.response.code} -> raising BadRequestException"
+        raise BadRequestException.new, parse_error(e, e.message)
+      rescue RestClient::InternalServerError => e
+        TophatterMerchant.logger.debug "#{e.class.name}: #{e.response.code} -> raising ServerErrorException"
+        raise ServerErrorException.new, parse_error(e, 'The server encountered an internal error. This is probably a bug, and you should contact support.')
       end
 
       def request(method:, url:, params:)
@@ -102,9 +95,9 @@ module TophatterMerchant
         rescue
           {}
         end
-        raise BadRequestException.new, error['message'] || fallback
-      end
 
+        error['message'] || fallback
+      end
     end
   end
 end

data/lib/tophatter_merchant/variation.rb

@@ -1,6 +1,5 @@
 module TophatterMerchant
   class Variation < Resource
-
     attr_accessor :identifier, :size, :color, :quantity, :created_at
 
     def id
@@ -8,7 +7,6 @@ module TophatterMerchant
     end
 
     class << self
-
       # ap TophatterMerchant::Variation.schema
       def schema
         get(url: "#{path}/schema.json")
@@ -34,8 +32,6 @@ module TophatterMerchant
       def path
         super + '/variations'
       end
-
     end
-
   end
 end

data/lib/tophatter_merchant/version.rb

@@ -1,3 +1,3 @@
 module TophatterMerchant
-  VERSION = '1.0'
+  VERSION = '1.1.1'.freeze
 end

data/spec/spec_helper.rb

@@ -6,7 +6,6 @@ WebMock.disable_net_connect!(allow_localhost: true)
 
 # http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
@@ -20,5 +19,4 @@ RSpec.configure do |config|
     stub_request(:get, /.*conditions\.json/).to_return(File.new(File.dirname(__FILE__) + '/../tmp/stubs/metadata/conditions.json'))
     stub_request(:get, /.*gemstones\.json/).to_return(File.new(File.dirname(__FILE__) + '/../tmp/stubs/metadata/gemstones.json'))
   end
-
 end

data/spec/tophatter_merchant/metadata_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 
 # rspec spec/tophatter_merchant/metadata_spec.rb
 describe TophatterMerchant::Metadata do
-
   it 'returns metadata' do
     metadata = TophatterMerchant::Metadata.all
     expect(metadata.keys.include?('categories')).to be true
@@ -34,5 +33,4 @@ describe TophatterMerchant::Metadata do
     expect(gemstones['Gemstones'].include?('Ruby')).to be true
     expect(gemstones['Gemstones'].include?("Micheal Jackson's Hair Diamond")).to be false
   end
-
 end

data/spec/tophatter_merchant/product_spec.rb

@@ -2,10 +2,8 @@ require 'spec_helper'
 
 # rspec spec/tophatter_merchant/product_spec.rb
 describe TophatterMerchant::Product do
-
   it 'instantiates' do
     product = TophatterMerchant::Product.new({})
     expect(product.persisted?).to be false
   end
-
 end

data/tophatter-merchant.gemspec

@@ -2,6 +2,9 @@
 $LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'tophatter_merchant/version'
 
+# To publish the next version:
+# gem build tophatter-merchant.gemspec
+# gem push tophatter-merchant-<version>.gem
 Gem::Specification.new do |s|
   s.name        = 'tophatter-merchant'
   s.version     = TophatterMerchant::VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tophatter-merchant
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.1.1
 platform: ruby
 authors:
 - Chris Estreich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-23 00:00:00.000000000 Z
+date: 2016-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -49,6 +49,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - CHANGELOG
 - Gemfile
 - LICENSE