gecko-ruby 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28ddc0bdac8932398a7129cd657ae2b80b5614ad
-  data.tar.gz: f2d47820b607c3d89fdffe2ad0958f031abbd2cb
+  metadata.gz: c85728687e6bc4e59c11d5214181af686b350033
+  data.tar.gz: 18cc56bd3df2520071e796eb191eb8c341bc4666
 SHA512:
-  metadata.gz: 8b88ce008228e17b33da355a96bad95572dc1b8df0231c2b9a36340cdf97ac34c3e4f137e4659b83a0d3da62162f0ee3f1eb21fd1594ae9cd56b6014f1d19a9b
-  data.tar.gz: 08f58c8995d09445c69688d072790687a82b35effbf16c0679e402aea548958abbde4ad84b1fae25f654365183767e20b82f2a7239c1b792e3103584a4ab881c
+  metadata.gz: 14c2cd95c537a35fb6a574c8991703333bd856a882f93bbca0f08922f7d2804ce0c512c7e91c40522be97fbe5d15e0e7fc40042705393c3c1a3e0dc818301aa5
+  data.tar.gz: 94114cbea7468c93308b60a8a68904874cd30f12588a2c801a27346f6767ccf3644911411ebecb52c94959d6be94d726c16c76894779c5e51ee2b348ff23d0f7

data/.rubocop.yml

@@ -6,7 +6,7 @@ AllCops:
 # private
 # ...
 # end
-Style/AccessModifierIndentation:
+Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
 
 Style/Blocks:
@@ -16,26 +16,26 @@ Style/Blocks:
 Style/BracesAroundHashParameters:
   Enabled: false
 
-Style/DotPosition:
+Layout/DotPosition:
   EnforcedStyle: leading
 
-Style/IndentHash:
+Layout/IndentHash:
   EnforcedStyle: consistent
 
-Style/LineLength:
+Metrics/LineLength:
   Max: 120
 
 Style/RedundantSelf:
   Enabled: false
 
 # We like neatly-aligned code
-Style/SingleSpaceBeforeFirstArg:
+Layout/SpaceBeforeFirstArg:
   Enabled: false
 
-Style/SpaceAroundEqualsInParameterDefault:
+Layout/SpaceAroundEqualsInParameterDefault:
   Enabled: false
 
-Style/SpaceInsideHashLiteralBraces:
+Layout/SpaceInsideHashLiteralBraces:
   Enabled: false
 
 # Allow single or double quotes
@@ -44,7 +44,7 @@ Style/StringLiterals:
 
 # 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:
+Layout/ExtraSpacing:
   Enabled: false
 
 Style/WordArray:
@@ -59,7 +59,7 @@ Style/SignalException:
 Metrics/ClassLength:
   Enabled: false
 
-Style/MultilineOperationIndentation:
+Layout/MultilineOperationIndentation:
   Enabled: false
 
 Style/ClassAndModuleChildren:

data/CHANGELOG.md

@@ -1,5 +1,10 @@
+## 0.2.3 (2017-08-14)
+- Add support for API idempotency @client.Record.save(idempotency_key: 'ABCDEF123456')
+- Marked a couple of fields as readonly that weren't correctly marked so
+
 ## 0.2.2 (2016-06-06)
 - Add `@client.Record.peek_all` to return all items currently in identity map
+
 ## 0.2.1 (2016-06-06) (Yanked)
 ## 0.2.0 (2016-06-06)
 - Support `writeable_on :create` for attributes

data/README.md

@@ -11,7 +11,7 @@ If you are unfamiliar with the TradeGecko API, you can read the documentation lo
 
 Add this line to your application's Gemfile:
 
-    gem 'gecko-ruby', '~> 0.0.9'
+    gem 'gecko-ruby'
 
 And then execute:
 

data/lib/gecko/record/base.rb

@@ -43,11 +43,14 @@ module Gecko
 
       # Save a record
       #
+      # @param [Hash] opts the options to save the record with
+      # @option opts [Hash] :idempotency_key A unique identifier for this action
+      #
       # @return <Gecko::Record::Base>
       #
       # @api public
-      def save
-        @client.adapter_for(self.class.demodulized_name).save(self)
+      def save(opts = {})
+        @client.adapter_for(self.class.demodulized_name).save(self, opts)
       end
 
       # Return the demodulized class name

data/lib/gecko/record/base_adapter.rb

@@ -185,7 +185,7 @@ module Gecko
       #
       # @api public
       def size
-        (@pagination && @pagination['total_records']) || count
+        (defined?(@pagination) && @pagination['total_records']) || count
       end
 
       # Fetch a record via API, regardless of whether it is already in identity map.
@@ -264,16 +264,18 @@ module Gecko
       # Save a record
       #
       # @params [Object] :record A Gecko::Record object
+      # @param [Hash] opts the options to make the request with
+      # @option opts [Hash] :idempotency_key A unique identifier for this action
       #
       # @return [Boolean] whether the save was successful.
       #                   If false the record will contain an errors hash
       #
       # @api private
-      def save(record)
+      def save(record, opts = {})
         if record.persisted?
-          update_record(record)
+          update_record(record, opts)
         else
-          create_record(record)
+          create_record(record, opts)
         end
       end
 
@@ -338,11 +340,11 @@ module Gecko
       # @return [OAuth2::Response]
       #
       # @api private
-      def create_record(record)
+      def create_record(record, opts = {})
         response = request(:post, plural_path, {
           body: record.as_json,
           raise_errors: false
-        })
+        }.merge(headers: headers_from_opts(opts)))
         handle_response(record, response)
       end
 
@@ -351,11 +353,11 @@ module Gecko
       # @return [OAuth2::Response]
       #
       # @api private
-      def update_record(record)
+      def update_record(record, opts = {})
         response = request(:put, plural_path + "/" + record.id.to_s, {
           body: record.as_json,
           raise_errors: false
-        })
+        }.merge(headers: headers_from_opts(opts)))
         handle_response(record, response)
       end
 
@@ -389,6 +391,15 @@ module Gecko
         @pagination = JSON.parse(headers["x-pagination"]) if headers["x-pagination"]
       end
 
+      # Applies an idempotency key to the request if provided
+      #
+      # @api private
+      def headers_from_opts(opts)
+        headers = {}
+        headers['Idempotency-Key'] = opts[:idempotency_key] if opts[:idempotency_key]
+        headers
+      end
+
       # Parse and instantiate sideloaded records
       #
       # @api private

data/lib/gecko/record/company.rb

@@ -29,8 +29,8 @@ module Gecko
 
       attribute :tax_number,             String
 
-      attribute :default_tax_rate,       BigDecimal
       attribute :default_discount_rate,  BigDecimal
+      attribute :default_tax_rate,       BigDecimal, readonly: true
     end
 
     class CompanyAdapter < BaseAdapter

data/lib/gecko/record/order.rb

@@ -11,7 +11,6 @@ module Gecko
       belongs_to :contact
       belongs_to :shipping_address,     class_name: 'Address'
       belongs_to :billing_address,      class_name: 'Address'
-      belongs_to :contact,              class_name: 'Contact'
       belongs_to :user,                 readonly: true
       belongs_to :assignee,             class_name: 'User'
       belongs_to :stock_location,       class_name: 'Location'

data/lib/gecko/version.rb

@@ -1,3 +1,3 @@
 module Gecko
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/test/client_test.rb

@@ -13,7 +13,7 @@ class ClientTest < Minitest::Test
   def test_custom_user_agent
     client  = Gecko::Client.new("ABC", "DEF")
     agent   = client.oauth_client.connection.headers["User-Agent"]
-    assert_match(%r|Gecko/#{Gecko::VERSION} OAuth2/\d.\d.\d Faraday/\d.\d.\d Ruby/\d.\d.\d|, agent)
+    assert_match(%r|Gecko/#{Gecko::VERSION} OAuth2/\d\.\d\.\d Faraday/\d\.\d+\.\d Ruby/\d\.\d\.\d|, agent)
   end
 
   def test_allows_test_URLs

data/test/helpers/serialization_helper_test.rb

@@ -76,7 +76,7 @@ class Gecko::Helpers::SerializationHelperTest < Minitest::Test
   end
 
   def test_root_key
-    record = Gecko::Record::OrderLineItem.new(@client, @json)
+    record = Gecko::Record::OrderLineItem.new(@client, {})
     assert_equal(:order_line_item, record.root)
   end
 

data/test/record/account_adapter_test.rb

@@ -10,6 +10,7 @@ class Gecko::Record::AccountAdapterTest < Minitest::Test
   undef :test_build_with_attributes
   undef :test_saving_new_record
   undef :test_saving_new_invalid_record
+  undef :test_saving_record_with_idempotency_key
 
   let(:adapter)       { @client.Account }
   let(:plural_name)   { 'accounts' }

data/test/record/user_adapter_test.rb

@@ -17,6 +17,7 @@ class Gecko::Record::UserAdapterTest < Minitest::Test
   undef :test_build_with_attributes
   undef :test_saving_new_record
   undef :test_saving_new_invalid_record
+  undef :test_saving_record_with_idempotency_key
 
   def test_current
     VCR.use_cassette('users#current') do

data/test/support/shared_adapter_examples.rb

@@ -66,7 +66,7 @@ module SharedAdapterExamples
   end
 
   def test_fetch_miss
-    request_stub = stub_request(:get, /#{plural_name}\/\d+/)
+    stub_request(:get, /#{plural_name}\/\d+/)
       .to_return({
         status:  404,
         headers: {"Content-Type" => "application/json"},
@@ -145,6 +145,23 @@ module SharedAdapterExamples
     assert(record.errors[:title].any?)
   end
 
+  def test_saving_record_with_idempotency_key
+    record = adapter.build
+    mock_token = mock
+    mock_response = mock(status: 200, parsed: {plural_name.singularize => {id: 123}})
+    mock_token.expects(:request)
+              .with(:post, plural_name, {
+                body: record.as_json.to_json,
+                raise_errors: false,
+                headers: {
+                  'Content-Type' => 'application/json',
+                  'Idempotency-Key' => 'abcdefghijkl'
+                }
+              }).returns(mock_response)
+    adapter.client.access_token = mock_token
+    adapter.save(record, idempotency_key: 'abcdefghijkl')
+  end
+
 private
   def mock_api_request(record, request, response)
     mock_token = mock

data/test/support/shared_record_examples.rb

@@ -11,7 +11,7 @@ module SharedRecordExamples
   end
 
   def test_saving
-    @client.adapter_for(record_class.demodulized_name).expects(:save).with(@record)
+    @client.adapter_for(record_class.demodulized_name).expects(:save).with(@record, {})
     @record.save
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gecko-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Bradley Priest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2017-08-14 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.6.4
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A Ruby interface to the TradeGecko API.