gecko-ruby 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3e9fd6fed6c04a1519102f2148126d4afce428a
-  data.tar.gz: 6f9df328f522933a00cc2153b1bdc0ddf3b21478
+  metadata.gz: 9c40754a9c277cd08ad49a2d852b695c75fe8c92
+  data.tar.gz: c2581aaebade775b562ea622f6cda0f3743ebed0
 SHA512:
-  metadata.gz: f2fd067297069ac22a4f11fe40690317c217b121c2eed07d286c386702c98105ba1546a30cc0a5ab9eb060742b159eea01bdfba6d314775f59968bd079d37039
-  data.tar.gz: 11fe376aeafdbbce26989aad6f7ff9d604bdf89b0e295907f0baf07e6baaf07a07d54e29f1f99d1db24982447afdcc210e5d04893a8d05d12ede80a42200a0df
+  metadata.gz: 3d8391b9645867eb544931162bdf71eb962868e94d997b2d16c9344d3f4657e1de29cc8d4de09d1392f5dc80b7d02b40111fbf59dc016ebf8bbdda5009f4266d
+  data.tar.gz: 6dbec0902e1e46fb6429dc6a6c194e0d4ddcbe1a6a615786cf873b71064431c92e78182ae5e1c07165db3e1fbe3c4941b710fbc5df4145dda0dac7764c3c30be

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -7,3 +7,7 @@ SpaceAroundEqualsInParameterDefault:
 
 IndentHash:
   Enabled: false
+
+# We like to line up the attribute definitions
+ExtraSpacing:
+  Enabled: false

data/.travis.yml

@@ -3,3 +3,4 @@ rvm:
   - 1.9.3
   - 2.0
   - 2.1
+  - 2.2

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Unreleased
+- Add size to base adapter
+- Update serialization_helper to support serializing arrays correctly
 
+## 0.0.4 (2015-01-09)
 - Renamed gem so we can publish it on RubyGems.org
 - Add `Gecko::Record::TaxType`
 - Add `Gecko::Record::PurchaseOrder` and `Gecko::Record::PurchaseOrderLineItem`

data/README.md

@@ -137,7 +137,7 @@ end
 
 ## Contributing
 
-1. Fork it ( http://github.com/[my-github-username]/gecko/fork )
+1. Fork it ( http://github.com/tradegecko/gecko/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`)

data/gecko-ruby.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "mocha"
+  spec.add_development_dependency "timecop"
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "thor"
   spec.add_development_dependency "pry"

data/lib/gecko/helpers/serialization_helper.rb

@@ -33,7 +33,7 @@ module Gecko
         attribute_hash
       end
 
-      # Serialize a single attribute
+      # Store the serialized representation of a single attribute
       #
       # @param [Hash] attribute_hash Serialized record being iterated over
       # @param [Virtus::Attribute] attribute The attribute being serialized
@@ -42,7 +42,29 @@ module Gecko
       #
       # @api private
       def serialize_attribute(attribute_hash, attribute)
-        attribute_hash[attribute.name] = attributes[attribute.name]
+        attribute_hash[attribute.name] = _serialize(attributes[attribute.name])
+      end
+
+      # Serialize an attribute
+      #
+      # @param [Object] serialized The attribute to serialize
+      #
+      # @return [String]
+      #
+      # @api private
+      def _serialize(serialized)
+        if serialized.respond_to?(:serializable_hash)
+          serialized.serializable_hash
+        else
+          case serialized
+          when Array
+            serialized.map { |attr| _serialize(attr) }
+          when BigDecimal
+            serialized.to_s("F")
+          else
+            serialized
+          end
+        end
       end
 
       # Return JSON root key for a record

data/lib/gecko/record/account.rb

@@ -24,7 +24,6 @@ module Gecko
 
       attribute :default_tax_rate, String
 
-      attribute :default_tax_type_id, Integer
 
       attribute :tax_number_label, String
       attribute :tax_label,        String
@@ -32,6 +31,7 @@ module Gecko
       belongs_to :billing_contact,          class_name: "User"
       belongs_to :primary_location,         class_name: "Location"
       belongs_to :primary_billing_location, class_name: "Location"
+      belongs_to :default_tax_type,         class_name: "TaxType"
 
       # belongs_to :default_currency, class_name: "Currency"
       # belongs_to :default_payment_term, class_name: "PaymentTerm"

data/lib/gecko/record/base_adapter.rb

@@ -115,12 +115,12 @@ module Gecko
         parse_records(parsed_response)
       end
 
-      # Return total count for a record type. Fetched from the metadata
+      # Returns the total count for a record type via API request.
       #
       # @example
       #   client.Product.count
       #
-      # @return [Integer] Total record count
+      # @return [Integer] Total number of available records
       #
       # @api public
       def count
@@ -128,6 +128,19 @@ module Gecko
         @pagination['total_records']
       end
 
+      # Returns the total count for a record type. Reads from the last request or
+      # makes a new request if not available.
+      #
+      # @example
+      #   client.Product.size
+      #
+      # @return [Integer] Total number of available records
+      #
+      # @api public
+      def size
+        (@pagination && @pagination['total_records']) || count
+      end
+
       # Fetch a record via API, regardless of whether it is already in identity map.
       #
       # @example

data/lib/gecko/record/company.rb

@@ -3,7 +3,8 @@ require 'gecko/record/base'
 module Gecko
   module Record
     class Company < Base
-      belongs_to :assignee, class_name: 'User'
+      belongs_to :assignee,         class_name: "User"
+      belongs_to :default_tax_type, class_name: "TaxType"
 
       has_many :addresses
       has_many :contacts
@@ -23,8 +24,6 @@ module Gecko
       attribute :tax_number,             String
 
       attribute :default_tax_rate,       BigDecimal
-      attribute :default_tax_type_id,    Integer
-
       attribute :default_discount_rate,  BigDecimal
 
       # belongs_to :default_price_list,   class_name: "PriceList"

data/lib/gecko/record/image.rb

@@ -16,8 +16,8 @@ module Gecko
 
       # URL for image
       #
-      # @param [Symbol] :size (:full) The image size, currently only :full
-      #   and :thumbnail supported
+      # @param [Symbol] :size (:full) The image size, currently only :full,
+      #  :medium and :thumbnail supported
       #
       # @return [String]
       #

data/lib/gecko/record/product.rb

@@ -16,7 +16,7 @@ module Gecko
 
       attribute :status,       String
 
-      # attribute :image_url,    String,  readonly: true
+      attribute :image_url,    String,  readonly: true
       # attribute :quantity,     Integer, readonly: true
       # attribute :search_cache, String,  readonly: true
     end

data/lib/gecko/record/tax_type.rb

@@ -5,11 +5,11 @@ module Gecko
     class TaxType < Base
       attribute :name,              String
       attribute :code,              String
-      attribute :xero_online_id,    String
-      attribute :imported_from,     String
-      attribute :effective_rate,    BigDecimal
+      attribute :xero_online_id,    String,     readonly: true
+      attribute :imported_from,     String,     readonly: true
+      attribute :effective_rate,    BigDecimal, readonly: true
 
-      attribute :status,            String
+      attribute :status,            String,     readonly: true
 
       # has_many :tax_components
     end

data/lib/gecko/record/variant.rb

@@ -5,6 +5,7 @@ module Gecko
     class Variant < Base
       class VariantLocation
         include Virtus.model
+        include Gecko::Helpers::SerializationHelper
         attribute :location_id,     Integer
         attribute :committed_stock, BigDecimal
         attribute :stock_on_hand,   BigDecimal
@@ -13,6 +14,7 @@ module Gecko
 
       class VariantPrice
         include Virtus.model
+        include Gecko::Helpers::SerializationHelper
         attribute :price_list_id,    String
         attribute :value,            BigDecimal
       end

data/lib/gecko/version.rb

@@ -1,3 +1,3 @@
 module Gecko
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/test/fixtures/vcr_cassettes/products_count.yml

@@ -53,6 +53,6 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"products":[],"meta":{"total":247}}'
-    http_version: 
+    http_version:
   recorded_at: Sat, 08 Mar 2014 04:18:46 GMT
 recorded_with: VCR 2.8.0

data/test/helpers/serialization_helper_test.rb

@@ -1,30 +1,78 @@
 require 'gecko'
+require 'test_helper'
 
 class Gecko::Helpers::SerializationHelperTest < Minitest::Test
-  def setup
-    @klass = Class.new(Gecko::Record::Base) do
-      attribute :name,   String
-      attribute :secret, String, readonly: true
+  Wodget = Class.new(Gecko::Record::Base) do
+    attribute :name, String
 
-      def root
-        :widget
-      end
+    def root
+      :wodget
     end
-    @client = Gecko::Client.new('ABC', 'DEF')
   end
 
-  def test_serializable_hash
-    record = @klass.new(@client, name: "Gecko", secret: "Iguana")
-    assert_equal({name: "Gecko"}, record.serializable_hash)
+  Widget = Class.new(Gecko::Record::Base) do
+    attribute :name,       String
+    attribute :secret,     String,       readonly: true
+    attribute :score,      BigDecimal
+    attribute :started_on, Date
+    attribute :started_at, DateTime
+    attribute :wodgets,    Array[Wodget]
+
+    def root
+      :widget
+    end
+  end
+
+  let(:record) do
+    Widget.new(@client, {
+      name:       "Gecko",
+      secret:     "Iguana",
+      score:      1.234,
+      started_at: DateTime.now,
+      started_on: Date.today,
+      wodgets:    [Wodget.new(@client, name: "Hi")]
+    })
+  end
+
+  def setup
+    Timecop.freeze
+    @client = Gecko::Client.new("ABC", "DEF")
+  end
+
+  def teardown
+    Timecop.return
   end
 
   def test_as_json
-    record = @klass.new(@client, name: "Gecko", secret: "Iguana")
-    assert_equal({widget: {name: "Gecko"}}, record.as_json)
+    assert_equal({widget: record.serializable_hash}, record.as_json)
+  end
+
+  def test_serializable_hash
+    assert_equal(serialized_record, record.serializable_hash)
+  end
+
+  def test_serializes_big_decimal_in_math_notation
+    assert_equal("1.234", record.serializable_hash[:score])
+  end
+
+  def test_serializes_arrays
+    assert_equal([{name: "Hi"}], record.serializable_hash[:wodgets])
   end
 
   def test_root_key
     record = Gecko::Record::OrderLineItem.new(@client, @json)
     assert_equal(:order_line_item, record.root)
   end
+
+private
+
+  def serialized_record
+    {
+      name:       "Gecko",
+      score:      "1.234",
+      started_on: Date.today,
+      started_at: DateTime.now,
+      wodgets:    [{name: "Hi"}]
+    }
+  end
 end

data/test/record/account_adapter_test.rb

@@ -3,6 +3,7 @@ class Gecko::Record::AccountAdapterTest < Minitest::Test
   include TestingAdapter
   include SharedAdapterExamples
   undef :test_adapter_count
+  undef :test_adapter_size
 
   # Can't build accounts via API
   undef :test_build

data/test/support/shared_adapter_examples.rb

@@ -21,6 +21,12 @@ module SharedAdapterExamples
     end
   end
 
+  def test_adapter_size
+    VCR.use_cassette(plural_name + '_count') do
+      assert(adapter.size > 10)
+    end
+  end
+
   def test_adapter_uses_identity_map
     VCR.use_cassette(plural_name) do
       collection = adapter.where(limit: 5)

data/test/test_helper.rb

@@ -4,6 +4,7 @@ require 'minitest/pride'
 require 'mocha/mini_test'
 require 'vcr'
 require 'webmock/minitest'
+require 'timecop'
 
 require 'support/let'
 require 'support/shared_adapter_examples'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gecko-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Bradley Priest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -186,6 +200,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md