gecko-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08f0ea519c51017bd91d6d4a2345c1610213a2f8
-  data.tar.gz: d3ec91d7ece3d1099d76b3f1de88f98be1e16505
+  metadata.gz: fd4c6e56d2678d03d389be05ba3e141724089e76
+  data.tar.gz: b7395c6ceab56b95dc79db04cfb0891564fb1b7a
 SHA512:
-  metadata.gz: 7ff2a4ed0decd8212e1c91a50fb9bfc4c9b256f21a77fce2008137172884d40e0fcf64dc1b5039f32e6d9005f335c4fed534ebca84d3aaa62cc7fc62fbd4fd1e
-  data.tar.gz: c07e8454750c183de6a4af0a9b88ea74b69cc1986ea2974d65f6f7d2867c8dfa1c4621fce172e58b25baeea36b9ce06196171402f65f4a1dc92dc850d5300dca
+  metadata.gz: bea2e880324d48b95e68289b5a41c0a21c7a42f55c62db2ac4233c8a81f29dbae606b381aa597733722e3bbb3ca5eac5e320a84a4c2f2b90b85ebc10cc483d28
+  data.tar.gz: c9e4065f15a4b4b15e05b50984f6403e811ce86311d1342f0f0eb6b19c56bed3d1572736a9ec6d7d1de8ff9c9651461692f1265167e7cc499b4a6ea6f13cc65c

data/.rubocop.yml

@@ -1,13 +1,66 @@
-# I personally disagree with this default and much rather outdented keywords
-AccessModifierIndentation:
+AllCops:
+  DisplayCopNames: true
+
+# class Example
+# ...
+# private
+# ...
+# end
+Style/AccessModifierIndentation:
   EnforcedStyle: outdent
 
-SpaceAroundEqualsInParameterDefault:
-  EnforcedStyle: no_space
+Style/Blocks:
+  Enabled: false
+
+# Allows foo(bar: baz)
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: leading
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/LineLength:
+  Max: 120
+
+Style/RedundantSelf:
+  Enabled: false
+
+# We like neatly-aligned code
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+# Allow single or double quotes
+Style/StringLiterals:
+  Enabled: false
 
-IndentHash:
+# Disable this until we can work out how to allow aligning of assignments
+# https://github.com/bbatsov/rubocop/blob/master/spec/rubocop/cop/style/extra_spacing_spec.rb#L23
+Style/ExtraSpacing:
   Enabled: false
 
-# We like to line up the attribute definitions
-ExtraSpacing:
+Style/WordArray:
   Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.2.0 (2016-06-06)
+- Support `writeable_on :create` for attributes
+- Allow passing query parameters to `Adapter#count`
+- Add `@client.Record.first` and `@client.Record.forty_two` as helpers
+- Store the last API response at `@client.Record.last_response`
+- Make sure to set Content-Type to `application/json`
+- Clean up some deprecated fields leading up to API release (See [https://developer.tradegecko.com](https://developer.tradegecko.com) for up-to-date attribute list)
+
 ## 0.1.0 (2015-11-25)
 - Move default headers to the adapter base class to make it easier to merge them when overriding
 - Clean up old attributes

data/README.md

@@ -139,6 +139,21 @@ ActiveSupport::Notifications.subscribe('request.gecko') do |name, start, finish,
 end
 ```
 
+## Checking API limits
+
+The Gecko gem stores a copy of the last API response per adapter.
+You can use this to access headers such as cache controls or current API limit usages.
+
+```ruby
+client.Product.find(124)
+client.Product.last_response.headers['X-Rate-Limit-Limit']
+#=> '300'
+client.Product.last_response.headers['X-Rate-Limit-Remaining']
+#=> '290'
+client.Product.last_response.headers['X-Rate-Limit-Reset']
+#=> '1412079600'
+```
+
 ## TODO
 - Deleting records
 - Complete record collection

data/generate.thor

@@ -59,7 +59,8 @@ class Gecko::#{@model_name}Test < Minitest::Test
   def test_initializes_record
     assert_instance_of(Gecko::Record::#{@model_name}, @record)
   end
-end}
+end
+}
   end
 
   def test_adapter_template
@@ -76,6 +77,7 @@ class Gecko::Record::#{@model_name}AdapterTest < Minitest::Test
   def test_initializes_adapter
     assert_instance_of(Gecko::Record::#{@model_name}Adapter, @client.#{@model_name})
   end
-end}
+end
+}
   end
 end

data/lib/gecko/helpers/serialization_helper.rb

@@ -27,12 +27,30 @@ module Gecko
       def serializable_hash
         attribute_hash = {}
         attribute_set.each do |attribute|
-          next if attribute.options[:readonly]
+          next unless writeable?(attribute)
           serialize_attribute(attribute_hash, attribute)
         end
         attribute_hash
       end
 
+      # Returns true if an attribute can be serialized
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def writeable?(attribute)
+        return if attribute.options[:readonly]
+        return true unless attribute.options[:writeable_on]
+        case attribute.options[:writeable_on]
+        when :update
+          persisted?
+        when :create
+          !persisted?
+        else
+          raise ArgumentError
+        end
+      end
+
       # Store the serialized representation of a single attribute
       #
       # @param [Hash] attribute_hash Serialized record being iterated over

data/lib/gecko/record/account.rb

@@ -37,10 +37,8 @@ module Gecko
       attribute :tax_label,        String
       attribute :tax_number_label, String
 
-      # attribute :stock_level_warn, String
-
       ## DEPRECATED
-      attribute :default_tax_rate, String
+      # attribute :default_tax_rate, String
       # attribute :default_tax_type, String
     end
 

data/lib/gecko/record/address.rb

@@ -3,7 +3,7 @@ require 'gecko/record/base'
 module Gecko
   module Record
     class Address < Base
-      belongs_to :company
+      belongs_to :company, writeable_on: :create
 
       attribute :label,        String
 

data/lib/gecko/record/base_adapter.rb

@@ -1,7 +1,7 @@
 module Gecko
   module Record
     class BaseAdapter
-      attr_reader :client
+      attr_reader :client, :last_response
       # Instantiates a new Record Adapter
       #
       # @param [Gecko::Client] client
@@ -84,10 +84,10 @@ module Gecko
         end
       end
 
-      # Make an API request with parameters. Parameters vary via Record Type
+      # Fetch a record collection via the API. Parameters vary via Record Type
       #
       # @example Fetch via ID
-      #   client.Product.where(ids: [1,2]
+      #   client.Product.where(ids: [1,2])
       #
       # @example Fetch via date
       #   client.Product.where(updated_at_min: "2014-03-03T21:09:00")
@@ -109,22 +109,57 @@ module Gecko
       #
       # @api public
       def where(params={})
-        response        = request(:get, plural_path, params: params)
+        response = @last_response = request(:get, plural_path, params: params)
         parsed_response = response.parsed
         set_pagination(response.headers)
         parse_records(parsed_response)
       end
 
+      # Fetch the first record for the given parameters
+      #
+      # @example Fetch via ID
+      #   client.Product.first
+      #
+      # @example Fetch via date
+      #   client.Product.first(updated_at_min: "2014-03-03T21:09:00")
+      #
+      # @example Search
+      #   client.Product.first(q: "gecko")
+      #
+      # @param [#to_hash] params
+      # @option params [String] :q Search query
+      # @option params [Array<Integer>] :ids IDs to search for
+      # @option params [String] :updated_at_min Last updated_at minimum
+      # @option params [String] :updated_at_max Last updated_at maximum
+      # @option params [String] :order Sort order i.e 'name asc'
+      # @option params [String, Array<String>] :status Record status/es
+      #
+      # @return <Gecko::Record::Base> A record instance
+      #
+      # @api public
+      def first(params={})
+        where(params.merge(limit: 1)).first
+      end
+
+      # Fetch the forty-second record for the given parameters
+      #
+      # @api public
+      def forty_two(params={})
+        where(params.merge(limit: 1, page: 42)).first
+      end
+
       # Returns the total count for a record type via API request.
       #
       # @example
       #   client.Product.count
       #
+      # @param [#to_hash] params
+      #
       # @return [Integer] Total number of available records
       #
       # @api public
-      def count
-        self.where(limit: 0)
+      def count(params = {})
+        self.where(params.merge(limit: 0))
         @pagination['total_records']
       end
 
@@ -154,7 +189,7 @@ module Gecko
       # @api private
       def fetch(id)
         verify_id_presence!(id)
-        response    = request(:get, plural_path + '/' + id.to_s)
+        response = @last_response = request(:get, plural_path + '/' + id.to_s)
         record_json = extract_record(response.parsed)
         instantiate_and_register_record(record_json)
       rescue OAuth2::Error => ex
@@ -377,6 +412,8 @@ module Gecko
           payload[:body]         = options[:body]
           payload[:model_class]  = model_class
           payload[:request_path] = path
+          options[:headers]      = options.fetch(:headers, {}).tap { |headers| headers['Content-Type'] = 'application/json' }
+          options[:body]         = options[:body].to_json if options[:body]
           payload[:response]     = @client.access_token.request(verb, path, options)
         end
       end

data/lib/gecko/record/contact.rb

@@ -3,7 +3,7 @@ require 'gecko/record/base'
 module Gecko
   module Record
     class Contact < Base
-      belongs_to :company
+      belongs_to :company, writeable_on: :create
 
       attribute :email,        String
       attribute :first_name,   String
@@ -18,7 +18,7 @@ module Gecko
       attribute :status,       String,  readonly: true
 
       ## DEPRECATED
-      attribute :phone,        String
+      # attribute :phone,        String
     end
 
     class ContactAdapter < BaseAdapter

data/lib/gecko/record/fulfillment.rb

@@ -4,9 +4,11 @@ require 'gecko/record/fulfillment_line_item'
 module Gecko
   module Record
     class Fulfillment < Base
-      belongs_to :order
+      belongs_to :order, writeable_on: :create
       belongs_to :shipping_address, class_name: 'Address'
       belongs_to :billing_address,  class_name: 'Address'
+      belongs_to :stock_location,  class_name: 'Location'
+
       has_many :fulfillment_line_items
 
       attribute :status,           String
@@ -16,7 +18,6 @@ module Gecko
       attribute :notes,            String
       attribute :tracking_url,     String
       attribute :tracking_company, String
-      attribute :destination_url,  String,  readonly: true
 
       attribute :packed_at,        Date
       attribute :shipped_at,       DateTime

data/lib/gecko/record/fulfillment_line_item.rb

@@ -3,8 +3,8 @@ require 'gecko/record/base'
 module Gecko
   module Record
     class FulfillmentLineItem < Base
-      belongs_to :fulfillment
-      belongs_to :order_line_item
+      belongs_to :fulfillment, writeable_on: :create
+      belongs_to :order_line_item, writeable_on: :create
 
       attribute :quantity,   BigDecimal
       attribute :base_price, BigDecimal, readonly: true

data/lib/gecko/record/invoice.rb

@@ -3,7 +3,7 @@ require 'gecko/record/base'
 module Gecko
   module Record
     class Invoice < Base
-      belongs_to :order
+      belongs_to :order, writeable_on: :create
       belongs_to :shipping_address
       belongs_to :billing_address
       belongs_to :payment_term
@@ -16,8 +16,10 @@ module Gecko
       attribute :notes,           String
       attribute :exchange_rate,   BigDecimal
 
-      attribute :destination_url, String,   readonly: true
-      attribute :document_url,    String,   readonly: true
+      attribute :status,          String,     readonly: true
+      attribute :payment_status,  String,     readonly: true
+      attribute :total,           BigDecimal, readonly: true
+      attribute :document_url,    String,     readonly: true
     end
 
     class InvoiceAdapter < BaseAdapter

data/lib/gecko/record/invoice_line_item.rb

@@ -3,7 +3,7 @@ require 'gecko/record/base'
 module Gecko
   module Record
     class InvoiceLineItem < Base
-      belongs_to :invoice
+      belongs_to :invoice, writeable_on: :create
       belongs_to :order_line_item
       # belongs_to :ledger_account
       attribute :ledger_account_id, Integer

data/lib/gecko/record/location.rb

@@ -3,7 +3,6 @@ require 'gecko/record/base'
 module Gecko
   module Record
     class Location < Base
-
       attribute :address1,     String
       attribute :address2,     String
       attribute :suburb,       String

data/lib/gecko/record/order.rb

@@ -28,7 +28,11 @@ module Gecko
       attribute :packed_status,         String,     readonly: true
       attribute :fulfillment_status,    String,     readonly: true
       attribute :invoice_status,        String,     readonly: true
-      attribute :payment_status,        String
+      attribute :payment_status,        String,     readonly: true
+      attribute :return_status,         String,     readonly: true
+      attribute :returning_status,      String,     readonly: true
+      attribute :shippability_status,   String,     readonly: true
+      attribute :backordering_status,   String,     readonly: true
       attribute :tax_treatment,         String
       attribute :issued_at,             Date
       attribute :ship_at,               Date

data/lib/gecko/record/order_line_item.rb

@@ -3,8 +3,8 @@ require 'gecko/record/base'
 module Gecko
   module Record
     class OrderLineItem < Base
-      belongs_to :order
-      belongs_to :variant
+      belongs_to :order, writeable_on: :create
+      belongs_to :variant, writeable_on: :create
       belongs_to :tax_type
 
       has_many :fulfillment_line_items

data/lib/gecko/record/product.rb

@@ -17,8 +17,6 @@ module Gecko
       attribute :status,       String
 
       attribute :image_url,    String,  readonly: true
-      # attribute :quantity,     Integer, readonly: true
-      # attribute :search_cache, String,  readonly: true
     end
 
     class ProductAdapter < BaseAdapter

data/lib/gecko/record/purchase_order.rb

@@ -19,18 +19,22 @@ module Gecko
       attribute :reference_number,      String
       attribute :email,                 String
       attribute :due_at,                Date
+      attribute :received_at,           Date
 
       attribute :status,                String
       attribute :procurement_status,    String,     readonly: true
       attribute :notes,                 String
       attribute :tax_treatment,         String
 
-      attribute :destination_url,       String,     readonly: true
       attribute :document_url,          String,     readonly: true
 
       attribute :total,                 BigDecimal, readonly: true
       attribute :cached_quantity,       BigDecimal, readonly: true
-      attribute :cached_total,          BigDecimal, readonly: true
+
+      attribute :tags,                  Array[String]
+
+      # DEPRECATED
+      # attribute :cached_total,          BigDecimal, readonly: true
     end
 
     class PurchaseOrderAdapter < BaseAdapter

data/lib/gecko/record/purchase_order_line_item.rb

@@ -3,8 +3,8 @@ require 'gecko/record/base'
 module Gecko
   module Record
     class PurchaseOrderLineItem < Base
-      belongs_to :purchase_order
-      belongs_to :variant
+      belongs_to :purchase_order, writeable_on: :create
+      belongs_to :variant, writeable_on: :create
       belongs_to :procurement
       belongs_to :tax_type
 

data/lib/gecko/record/tax_type.rb

@@ -9,7 +9,7 @@ module Gecko
 
       attribute :status,            String,     readonly: true
 
-      # has_many :tax_components
+      has_many :tax_components
     end
 
     class TaxTypeAdapter < BaseAdapter

data/lib/gecko/record/user.rb

@@ -16,11 +16,6 @@ module Gecko
       attribute :status,             String,   readonly: true
       attribute :billing_contact,    Boolean,  readonly: true
 
-      # attribute :sales_report_email, Boolean
-      # attribute :action_items_email, String
-
-      # attribute :notification_email, Boolean
-      # attribute :permissions,        Array[String]
       # attribute :account_id,         Integer
 
       ## DEPRECATED

data/lib/gecko/record/variant.rb

@@ -21,7 +21,7 @@ module Gecko
         attribute :value,            BigDecimal
       end
 
-      belongs_to :product
+      belongs_to :product, writeable_on: :create
       has_many :images
 
       attribute :name,            String
@@ -36,6 +36,7 @@ module Gecko
       attribute :opt3,            String
 
       attribute :weight,          String
+      attribute :weight_unit,     String
 
       attribute :status,          String,   readonly: true
 
@@ -54,7 +55,6 @@ module Gecko
       attribute :reorder_point,   Integer
       attribute :max_online,      Integer
 
-      attribute :composite,       Boolean
       attribute :keep_selling,    Boolean
       attribute :taxable,         Boolean
       attribute :sellable,        Boolean
@@ -63,11 +63,16 @@ module Gecko
       attribute :position,        Integer
 
       attribute :stock_on_hand,   BigDecimal, readonly: true
+      attribute :incoming_stock,  BigDecimal, readonly: true
       attribute :committed_stock, BigDecimal, readonly: true
 
       attribute :locations,       Array[VariantLocation]
       attribute :variant_prices,  Array[VariantPrice]
 
+      attribute :composite,           Boolean,    writeable_on: :create
+      attribute :initial_stock_level, BigDecimal, writeable_on: :create
+      attribute :initial_cost_price,  BigDecimal, writeable_on: :create
+
       # Returns a display name for a variant
       #
       # @example

data/lib/gecko/version.rb

@@ -1,3 +1,3 @@
 module Gecko
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/test/helpers/serialization_helper_test.rb

@@ -13,6 +13,8 @@ class Gecko::Helpers::SerializationHelperTest < Minitest::Test
   Widget = Class.new(Gecko::Record::Base) do
     attribute :name,       String
     attribute :secret,     String,       readonly: true
+    attribute :initial_stock, BigDecimal, writeable_on: :create
+    attribute :update_stock, BigDecimal, writeable_on: :update
     attribute :score,      BigDecimal
     attribute :started_on, Date
     attribute :started_at, DateTime
@@ -27,6 +29,8 @@ class Gecko::Helpers::SerializationHelperTest < Minitest::Test
     Widget.new(@client, {
       name:       "Gecko",
       secret:     "Iguana",
+      initial_stock: 10.0,
+      update_stock: 10.0,
       score:      1.234,
       started_at: DateTime.now,
       started_on: Date.today,
@@ -47,6 +51,18 @@ class Gecko::Helpers::SerializationHelperTest < Minitest::Test
     assert_equal({widget: record.serializable_hash}, record.as_json)
   end
 
+  def test_writeable_on_create
+    assert_equal(serialized_record, record.serializable_hash)
+  end
+
+  def test_writeable_on_update
+    cleaned_record = serialized_record
+    cleaned_record.delete(:initial_stock)
+    cleaned_record[:update_stock] = "10.0"
+    record.id = 1
+    assert_equal(cleaned_record, record.serializable_hash)
+  end
+
   def test_serializable_hash
     assert_equal(serialized_record, record.serializable_hash)
   end
@@ -69,6 +85,7 @@ private
   def serialized_record
     {
       name:       "Gecko",
+      initial_stock: "10.0",
       score:      "1.234",
       started_on: Date.today,
       started_at: DateTime.now,

data/test/record/fulfillment_test.rb

@@ -18,7 +18,7 @@ class Gecko::FulfillmentTest < Minitest::Test
 
   def test_serialization
     json_keys = %w(
-      order_id shipping_address_id billing_address_id status exchange_rate
+      order_id shipping_address_id billing_address_id status stock_location_id exchange_rate
       delivery_type tracking_number notes tracking_url tracking_company packed_at
       service shipped_at received_at receipt
     ).map(&:to_sym)

data/test/support/shared_adapter_examples.rb

@@ -150,7 +150,7 @@ private
     mock_token = mock
     mock_response = mock(status: response[0], parsed: response[1])
     mock_token.expects(:request)
-              .with(request[0], request[1], body: record.as_json, raise_errors: false)
+              .with(request[0], request[1], body: record.as_json.to_json, raise_errors: false, headers: {'Content-Type' => 'application/json'})
               .returns(mock_response)
     adapter.client.access_token = mock_token
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gecko-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bradley Priest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -357,7 +357,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: A Ruby interface to the TradeGecko API.