my_john_deere_api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31aa8280a3df1a7eb45d47c7f5d8a3f6606316b5d7bec7ce42256a843beb0274
-  data.tar.gz: d1cff664da5725a67903fdfc1d71b344b26c038099b456295302cb4b0949f1b0
+  metadata.gz: 5005d82b1ef3ac1363022c0a4344000cd823bef860301bc9a067f3d5ac200cbc
+  data.tar.gz: df32f8ea65db2bb668f23fa1a9c7e48db055abf6fc85dbeb84b51d97db777050
 SHA512:
-  metadata.gz: 555d80933c95a91da91ed4892ecc8e3243d6d7df448ed220f8921973dbfa93737e98e9d5be74a96c7509d4361c05bba257828be37e49580b1b56c911da569ecc
-  data.tar.gz: 33efb9f16ef9323279aa6449b9bbc21c532db6130ee2bbb7da4dba47a93510c8d36af6efb4c17262805fe26a0e2f2e4ee083ed7a65fa98aadd00b00c9410e42a
+  metadata.gz: 85b45d83f40727e26a7259c4237abe4d876a4eb6edb9c73eca3764ceb3253d5220729ac4fa52ab7b03e3e9fad4fbf2efbc3d97c91a80f7f57e17704b69cc89fe
+  data.tar.gz: 6511158e47fc47504f0143569ad435f00e45cd9cfa24a52be526bfd20f22d9f606bed14d22246fa1f0308865bebb92ad8b449dd41476fe269511011bb7ea5318

data/lib/my_john_deere_api/client.rb

@@ -46,7 +46,7 @@ class MyJohnDeereApi::Client
 
   def organizations
     return @organizations if defined?(@organizations)
-    @organizations = MyJohnDeereApi::Request::Organizations.new(accessor).all
+    @organizations = MyJohnDeereApi::Request::Collection::Organizations.new(accessor).all
   end
 
   private

data/lib/my_john_deere_api/consumer.rb

@@ -1,85 +1,89 @@
-class MyJohnDeereApi::Consumer
-  attr_reader :api_key, :api_secret, :environment, :base_url
-
-  # valid API urls
-  URLS = {
-    sandbox: 'https://sandboxapi.deere.com',
-    production: 'https://api.soa-proxy.deere.com',
-  }
-
-  DEFAULTS = {
-    environment: :production
-  }
-
-  def initialize(api_key, api_secret, options={})
-    options = DEFAULTS.merge(options)
-
-    @api_key = api_key
-    @api_secret = api_secret
-
-    @environment = options[:environment]
-    @base_url = options[:base_url] || URLS[@environment]
-  end
-
-  ##
-  # oAuth Consumer which uses just the base url, for
-  # app-wide, non user-specific GET requests.
-
-  def app_get
-    @app_get ||= consumer(base_url)
-  end
-
-  ##
-  # oAuth Consumer which uses the proper url for user-specific GET requests.
-
-  def user_get
-    @user_get ||= consumer("#{base_url}/platform")
-  end
-
-  private
-
-  def consumer(site)
-    OAuth::Consumer.new(
-      api_key,
-      api_secret,
-      site: site,
-      header: header,
-      http_method: :get,
-      request_token_url: links[:request_token],
-      access_token_url: links[:access_token],
-      authorize_url: links[:authorize_request_token]
-    )
-  end
-
-  def links
-    return @links if defined?(@links)
-
-    catalog = OAuth::Consumer.new(api_key, api_secret)
-      .request(
-        :get,
-        "#{base_url}/platform/",
-        nil,
-        {},
-        header
-      ).body
-
-      @links = {}
-
-      JSON.parse(catalog)['links'].each do |link|
-        uri = URI.parse(link['uri'])
-        uri.query = nil
-
-        @links[keyify(link['rel'])] = uri.to_s
-      end
-
-      @links
-  end
-
-  def header
-    @header ||= {accept: 'application/vnd.deere.axiom.v3+json'}
-  end
-
-  def keyify key_name
-    key_name.gsub(/^oauth/, '').gsub(/([a-z])([A-Z])/, '\1_\2').downcase.to_sym
+module MyJohnDeereApi
+  class Consumer
+    include Helpers::CaseConversion
+
+    attr_reader :api_key, :api_secret, :environment, :base_url
+
+    # valid API urls
+    URLS = {
+      sandbox: 'https://sandboxapi.deere.com',
+      production: 'https://api.soa-proxy.deere.com',
+    }
+
+    DEFAULTS = {
+      environment: :production
+    }
+
+    def initialize(api_key, api_secret, options={})
+      options = DEFAULTS.merge(options)
+
+      @api_key = api_key
+      @api_secret = api_secret
+
+      @environment = options[:environment]
+      @base_url = options[:base_url] || URLS[@environment]
+    end
+
+    ##
+    # oAuth Consumer which uses just the base url, for
+    # app-wide, non user-specific GET requests.
+
+    def app_get
+      @app_get ||= consumer(base_url)
+    end
+
+    ##
+    # oAuth Consumer which uses the proper url for user-specific GET requests.
+
+    def user_get
+      @user_get ||= consumer("#{base_url}/platform")
+    end
+
+    private
+
+    def consumer(site)
+      OAuth::Consumer.new(
+        api_key,
+        api_secret,
+        site: site,
+        header: header,
+        http_method: :get,
+        request_token_url: links[:request_token],
+        access_token_url: links[:access_token],
+        authorize_url: links[:authorize_request_token]
+      )
+    end
+
+    def links
+      return @links if defined?(@links)
+
+      catalog = OAuth::Consumer.new(api_key, api_secret)
+        .request(
+          :get,
+          "#{base_url}/platform/",
+          nil,
+          {},
+          header
+        ).body
+
+        @links = {}
+
+        JSON.parse(catalog)['links'].each do |link|
+          uri = URI.parse(link['uri'])
+          uri.query = nil
+
+          @links[keyify(link['rel'])] = uri.to_s
+        end
+
+        @links
+    end
+
+    def header
+      @header ||= {accept: 'application/vnd.deere.axiom.v3+json'}
+    end
+
+    def keyify key_name
+      underscore(key_name.gsub(/^oauth/, '')).to_sym
+    end
   end
-end
+end

data/lib/my_john_deere_api/errors/access_token_error.rb

@@ -0,0 +1,12 @@
+module MyJohnDeereApi
+  ##
+  # This error is used in a context that will fail in the absence of
+  # a valid oAuth access token. We have classes that may only need 
+  # access tokens for some use cases.
+
+  class AccessTokenError < StandardError
+    def initialize(message = "A valid oAuth Access Token must be supplied to use this feature.")
+      super
+    end
+  end
+end

data/lib/my_john_deere_api/errors.rb

@@ -1,12 +1,3 @@
-module MyJohnDeereApi
-  ##
-  # This error is used in a context that will fail in the absence of
-  # a valid oAuth access token. We have classes that may only need 
-  # access tokens for some use cases.
-
-  class AccessTokenError < StandardError
-    def initialize(message = "A valid oAuth Access Token must be supplied to use this feature.")
-      super
-    end
-  end
+module MyJohnDeereApi::Errors
+  require           'my_john_deere_api/errors/access_token_error'
 end

data/lib/my_john_deere_api/helpers/case_conversion.rb

@@ -0,0 +1,27 @@
+require 'uri'
+
+module MyJohnDeereApi::Helpers::CaseConversion
+  ##
+  # convert a text or camelcase string to underscore
+
+  def underscore(string)
+    string.gsub(/([a-z])([A-Z])/, '\1_\2').gsub(/\s+/, '_').gsub(/_+/, '_').downcase
+  end
+
+  private :underscore
+
+  ##
+  # convert text or underscored string to camelcase
+
+  def camelize(string)
+    list = string.strip.split(/[_\s]+/)
+
+    # preserve case of the first element
+    new_list = [list.shift]
+    new_list += list.map(&:capitalize)
+
+    new_list.join('')
+  end
+
+  private :camelize
+end

data/lib/my_john_deere_api/helpers.rb

@@ -1,3 +1,4 @@
 module MyJohnDeereApi::Helpers
   autoload :UriPath,        'my_john_deere_api/helpers/uri_path'
+  autoload :CaseConversion, 'my_john_deere_api/helpers/case_conversion'
 end

data/lib/my_john_deere_api/model/field.rb

@@ -4,6 +4,15 @@ module MyJohnDeereApi
 
     attr_reader :name, :id, :links, :accessor
 
+    ##
+    # arguments:
+    #
+    # [record] a JSON object of type 'Field', returned from the API.
+    #
+    # [accessor (optional)] a valid oAuth Access Token. This is only
+    #                       needed if further API requests are going
+    #                       to be made, as is the case with *flags*.
+
     def initialize(record, accessor = nil)
       @accessor = accessor
 
@@ -18,6 +27,10 @@ module MyJohnDeereApi
       end
     end
 
+    ##
+    # Since the archived attribute is boolean, we reflect this in the
+    # method name instead of using a standard attr_reader.
+
     def archived?
       @archived
     end

data/lib/my_john_deere_api/model/flag.rb

@@ -0,0 +1,51 @@
+require 'json'
+
+module MyJohnDeereApi
+  class Model::Flag
+    include Helpers::CaseConversion
+    include Helpers::UriPath
+
+    attr_reader :id, :notes, :geometry, :links, :accessor
+
+    ##
+    # arguments:
+    #
+    # [record] a JSON object of type 'Flag', returned from the API.
+    #
+    # [accessor (optional)] a valid oAuth Access Token. This is only
+    #                       needed if further API requests are going
+    #                       to be made.
+
+    def initialize(record, accessor = nil)
+      @accessor = accessor
+
+      @id = record['id']
+      @notes = record['notes']
+      @geometry =JSON.parse(record['geometry'])
+      @proximity_alert_enabled = record['proximityAlertEnabled']
+      @archived = record['archived']
+
+      @links = {}
+
+      record['links'].each do |association|
+        @links[underscore(association['rel'])] = uri_path(association['uri'])
+      end
+    end
+
+    ##
+    # Since the archived attribute is boolean, we reflect this in the
+    # method name instead of using a standard attr_reader.
+
+    def archived?
+      @archived
+    end
+
+    ##
+    # Since the proximity_alert_enabled attribute is boolean, we reflect this
+    # in the method name instead of using a standard attr_reader.
+
+    def proximity_alert_enabled?
+      @proximity_alert_enabled
+    end
+  end
+end

data/lib/my_john_deere_api/model/organization.rb

@@ -6,6 +6,15 @@ module MyJohnDeereApi
 
     attr_reader :name, :type, :id, :links, :accessor
 
+    ##
+    # arguments:
+    #
+    # [record] a JSON object of type 'Organization', returned from the API.
+    #
+    # [accessor (optional)] a valid oAuth Access Token. This is only
+    #                       needed if further API requests are going
+    #                       to be made, as is the case with *fields*.
+
     def initialize(record, accessor = nil)
       @accessor = accessor
 
@@ -21,6 +30,10 @@ module MyJohnDeereApi
       end
     end
 
+    ##
+    # Since the member attribute is boolean, we reflect this in the
+    # method name instead of using a standard attr_reader.
+
     def member?
       @member
     end
@@ -32,7 +45,7 @@ module MyJohnDeereApi
       raise AccessTokenError unless accessor
 
       return @fields if defined?(@fields)
-      @fields = MyJohnDeereApi::Request::Fields.new(accessor, organization: id).all
+      @fields = MyJohnDeereApi::Request::Collection::Fields.new(accessor, organization: id).all
     end
   end
 end

data/lib/my_john_deere_api/model.rb

@@ -1,4 +1,5 @@
 module MyJohnDeereApi::Model
   autoload :Organization,        'my_john_deere_api/model/organization'
   autoload :Field,               'my_john_deere_api/model/field'
+  autoload :Flag,                'my_john_deere_api/model/flag'
 end

data/lib/my_john_deere_api/request/collection/base.rb

@@ -0,0 +1,83 @@
+module MyJohnDeereApi
+  class Request::Collection::Base
+    include Enumerable
+    include Helpers::UriPath
+
+    attr_reader :accessor, :associations
+
+    ##
+    # accessor is an OAuth::AccessToken object which has the necessary
+    # credentials to make the desired requests.
+
+    def initialize(accessor, associations = {})
+      @accessor = accessor
+      @associations = associations
+      @items = []
+    end
+
+    ##
+    # Iterate lazily through all records in the collection, fetching
+    # additional pages as needed.
+
+    def each(&block)
+      count.times do |index|
+        fetch if @items.size <= index
+        block.call(@items[index])
+      end
+    end
+
+    ##
+    # Return all objects in the collection at once
+
+    def all
+      return @all if defined?(@all)
+      @all = map { |i| i }
+    end
+
+    ##
+    # Total count of records, even before pagination
+
+    def count
+      @count ||= first_page['total']
+    end
+
+    private
+
+    def first_page
+      return @first_page if defined?(@first_page)
+
+      @first_page = JSON.parse(@accessor.get(resource, headers).body)
+      extract_page_contents(@first_page)
+
+      @first_page
+    end
+
+    def fetch
+      return unless @next_page
+
+      page = JSON.parse(@accessor.get(@next_page, headers).body)
+      extract_page_contents(page)
+    end
+
+    def headers
+      @headers ||= {accept: 'application/vnd.deere.axiom.v3+json'}
+    end
+
+    def extract_page_contents(page)
+      add_items_from_page(page)
+      set_next_page(page)
+    end
+
+    def add_items_from_page(page)
+      @items += page['values'].map{|record| model.new(record, accessor) }
+    end
+
+    def set_next_page(page)
+      if next_page = page['links'].detect{|link| link['rel'] == 'nextPage'}
+        @next_page = uri_path(next_page['uri'])
+      else
+        @next_page = nil
+      end
+    end
+  end
+end

data/lib/my_john_deere_api/request/{fields.rb → collection/fields.rb}

@@ -1,7 +1,7 @@
 require 'json'
 
 module MyJohnDeereApi::Request
-  class Fields < Collection
+  class Collection::Fields < Collection::Base
     ##
     # The resource path for the first page in the collection
 

data/lib/my_john_deere_api/request/collection/flags.rb

@@ -0,0 +1,19 @@
+require 'json'
+
+module MyJohnDeereApi::Request
+  class Collection::Flags < Collection::Base
+    ##
+    # The resource path for the first page in the collection
+
+    def resource
+      "/organizations/#{associations[:organization]}/fields/#{associations[:field]}/flags"
+    end
+
+    ##
+    # This is the class used to model the data
+
+    def model
+      MyJohnDeereApi::Model::Flag
+    end
+  end
+end

data/lib/my_john_deere_api/request/{organizations.rb → collection/organizations.rb}

@@ -1,7 +1,7 @@
 require 'json'
 
 module MyJohnDeereApi::Request
-  class Organizations < Collection
+  class Collection::Organizations < Collection::Base
     ##
     # The resource path for the first page in the collection
 

data/lib/my_john_deere_api/request/collection.rb

@@ -1,83 +1,6 @@
-module MyJohnDeereApi
-  class Request::Collection
-    include Enumerable
-    include Helpers::UriPath
-
-    attr_reader :accessor, :associations
-
-    ##
-    # accessor is an OAuth::AccessToken object which has the necessary
-    # credentials to make the desired requests.
-
-    def initialize(accessor, associations = {})
-      @accessor = accessor
-      @associations = associations
-      @items = []
-    end
-
-    ##
-    # Iterate lazily through all records in the collection, fetching
-    # additional pages as needed.
-
-    def each(&block)
-      count.times do |index|
-        fetch if @items.size <= index
-        block.call(@items[index])
-      end
-    end
-
-    ##
-    # Return all objects in the collection at once
-
-    def all
-      return @all if defined?(@all)
-      @all = map { |i| i }
-    end
-
-    ##
-    # Total count of records, even before pagination
-
-    def count
-      @count ||= first_page['total']
-    end
-
-    private
-
-    def first_page
-      return @first_page if defined?(@first_page)
-
-      @first_page = JSON.parse(@accessor.get(resource, headers).body)
-      extract_page_contents(@first_page)
-
-      @first_page
-    end
-
-    def fetch
-      return unless @next_page
-
-      page = JSON.parse(@accessor.get(@next_page, headers).body)
-      extract_page_contents(page)
-    end
-
-    def headers
-      @headers ||= {accept: 'application/vnd.deere.axiom.v3+json'}
-    end
-
-    def extract_page_contents(page)
-      add_items_from_page(page)
-      set_next_page(page)
-    end
-
-    def add_items_from_page(page)
-      @items += page['values'].map{|record| model.new(record, accessor) }
-    end
-
-    def set_next_page(page)
-      if next_page = page['links'].detect{|link| link['rel'] == 'nextPage'}
-        @next_page = uri_path(next_page['uri'])
-      else
-        @next_page = nil
-      end
-    end
-  end
+module MyJohnDeereApi::Request::Collection
+  autoload :Base,                 'my_john_deere_api/request/collection/base'
+  autoload :Organizations,        'my_john_deere_api/request/collection/organizations'
+  autoload :Fields,               'my_john_deere_api/request/collection/fields'
+  autoload :Flags,               'my_john_deere_api/request/collection/flags'
 end

data/lib/my_john_deere_api/request.rb

@@ -1,5 +1,3 @@
 module MyJohnDeereApi::Request
   autoload :Collection,           'my_john_deere_api/request/collection'
-  autoload :Organizations,        'my_john_deere_api/request/organizations'
-  autoload :Fields,               'my_john_deere_api/request/fields'
 end

data/lib/my_john_deere_api/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeereApi
-  VERSION='0.3.0'
+  VERSION='0.4.0'
 end

data/test/lib/my_john_deere_api/errors/test_access_token_error.rb

@@ -0,0 +1,13 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi::AccessTokenError' do
+  it 'inherits from StandardError' do
+    error = MyJohnDeereApi::AccessTokenError.new
+    assert_kind_of StandardError, error
+  end
+
+  it 'has a default message' do
+    error = MyJohnDeereApi::AccessTokenError.new
+    assert_includes error.message, 'Access Token must be supplied'
+  end
+end

data/test/lib/my_john_deere_api/helpers/test_case_conversion.rb

@@ -0,0 +1,56 @@
+require 'support/helper'
+
+class CaseConversionHelperSample
+  include JD::Helpers::CaseConversion
+end
+
+describe 'Helpers::CaseConversion' do
+  let(:object) { CaseConversionHelperSample.new }
+
+  describe '#underscore' do
+    it 'converts from camelcase' do
+      string = object.send(:underscore, 'camelCaseExample')
+      assert_equal 'camel_case_example', string
+    end
+
+    it 'handles leading uppercase' do
+      string = object.send(:underscore, 'CamelCaseExample')
+      assert_equal 'camel_case_example', string
+    end
+
+    it 'converts spaces to underscores' do
+      string = object.send(:underscore, 'camel case Example')
+      assert_equal 'camel_case_example', string
+    end
+
+    it 'removes duplicate underscores after processing' do
+      string = object.send(:underscore, 'camel  Case     Example')
+      assert_equal 'camel_case_example', string
+    end
+
+    it 'is a private method' do
+      assert_raises(NoMethodError) { object.underscore('test') }
+    end
+  end
+
+  describe '#camelize' do
+    it 'converts from underscored' do
+      string = object.send(:camelize, 'this_is_a_test')
+      assert_equal 'thisIsATest', string
+    end
+
+    it 'converts from spaced' do
+      string = object.send(:camelize, 'this is a test')
+      assert_equal 'thisIsATest', string
+    end
+
+    it 'honors original capitalization' do
+      string = object.send(:camelize, 'This is a test')
+      assert_equal 'ThisIsATest', string
+    end
+
+    it 'is a private method' do
+      assert_raises(NoMethodError) { object.camelize('test') }
+    end
+  end
+end

data/test/lib/my_john_deere_api/model/test_flag.rb

@@ -0,0 +1,52 @@
+require 'support/helper'
+require 'json'
+
+describe 'MyJohnDeereApi::Model::Flag' do
+  let(:record) do
+    {
+      "@type"=>"Flag",
+      "geometry"=>"{\"type\": \"Point\", \"coordinates\": [-93.14959274063109, 41.66881548411553] }",
+      "archived"=>true,
+      "proximityAlertEnabled"=>true,
+      "notes"=>"Our flag is a very, very, very nice flag!",
+      "id"=>"123456",
+      "links"=>[
+        {"@type"=>"Link", "rel"=>"field", "uri"=>"https://sandboxapi.deere.com/platform/organizations/123456/fields/123456"},
+        {"@type"=>"Link", "rel"=>"createdBy", "uri"=>"https://sandboxapi.deere.com/platform/users/bobsmith"},
+        {"@type"=>"Link", "rel"=>"lastModifiedBy", "uri"=>"https://sandboxapi.deere.com/platform/users/jonsmith"},
+      ]
+    }
+  end
+
+  describe '#initialize' do
+    def link_for label
+      record['links'].detect{|link| link['rel'] == label}['uri'].gsub('https://sandboxapi.deere.com/platform', '')
+    end
+
+    it 'sets the attributes from the given record' do
+      field = JD::Model::Flag.new(record)
+
+      assert_nil field.accessor
+
+      # basic attributes
+      assert_equal JSON.parse(record['geometry']), field.geometry
+      assert_equal record['archived'], field.archived?
+      assert_equal record['proximityAlertEnabled'], field.proximity_alert_enabled?
+      assert_equal record['notes'], field.notes
+      assert_equal record['id'], field.id
+
+      # links to other things
+      assert_kind_of Hash, field.links
+      assert_equal link_for('field'), field.links['field']
+      assert_equal link_for('createdBy'), field.links['created_by']
+      assert_equal link_for('lastModifiedBy'), field.links['last_modified_by']
+    end
+
+    it 'accepts an optional accessor' do
+      accessor = 'mock-accessor'
+
+      field = JD::Model::Flag.new(record, accessor)
+      assert_equal accessor, field.accessor
+    end
+  end
+end

data/test/lib/my_john_deere_api/request/collection/test_base.rb

@@ -0,0 +1,28 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi::Request::Collection::Base' do
+  let(:client) { JD::Client.new(API_KEY, API_SECRET, environment: :sandbox, access: [ACCESS_TOKEN, ACCESS_SECRET]) }
+  let(:accessor) { VCR.use_cassette('catalog') { client.send(:accessor) } }
+
+  describe '#initialize(access_token)' do
+    it 'accepts an access token' do
+      collection = JD::Request::Collection::Base.new(accessor)
+      assert_kind_of OAuth::AccessToken, collection.accessor
+    end
+
+    it 'accepts associations' do
+      collection = JD::Request::Collection::Base.new(accessor, organization: '123')
+
+      assert_kind_of Hash, collection.associations
+      assert_equal '123', collection.associations[:organization]
+    end
+  end
+
+  it 'uses the Enumerable module' do
+    collection = JD::Request::Collection::Base.new(accessor)
+
+    [:each, :first, :map, :detect, :select].each do |method_name|
+      assert collection.respond_to?(method_name)
+    end
+  end
+end

data/test/lib/my_john_deere_api/request/{test_fields.rb → collection/test_fields.rb}

@@ -2,7 +2,7 @@ require 'support/helper'
 require 'yaml'
 require 'json'
 
-describe 'MyJohnDeereApi::Request::Fields' do
+describe 'MyJohnDeereApi::Request::Collection::Fields' do
   let(:organization_id) do
     contents = File.read('test/support/vcr/get_organizations.yml')
     body = YAML.load(contents)['http_interactions'].first['response']['body']['string']
@@ -11,7 +11,7 @@ describe 'MyJohnDeereApi::Request::Fields' do
 
   let(:client) { JD::Client.new(API_KEY, API_SECRET, environment: :sandbox, access: [ACCESS_TOKEN, ACCESS_SECRET]) }
   let(:accessor) { VCR.use_cassette('catalog') { client.send(:accessor) } }
-  let(:collection) { JD::Request::Fields.new(accessor, organization: organization_id) }
+  let(:collection) { JD::Request::Collection::Fields.new(accessor, organization: organization_id) }
 
   describe '#initialize(access_token)' do
     it 'accepts an access token' do
@@ -19,7 +19,7 @@ describe 'MyJohnDeereApi::Request::Fields' do
     end
 
     it 'accepts associations' do
-      collection = JD::Request::Organizations.new(accessor, organization: '123')
+      collection = JD::Request::Collection::Fields.new(accessor, organization: '123')
 
       assert_kind_of Hash, collection.associations
       assert_equal '123', collection.associations[:organization]

data/test/lib/my_john_deere_api/request/collection/test_flags.rb

@@ -0,0 +1,90 @@
+require 'support/helper'
+require 'yaml'
+require 'json'
+
+describe 'MyJohnDeereApi::Request::Collection::Flags' do
+  let(:organization_id) do
+    contents = File.read('test/support/vcr/get_organizations.yml')
+    body = YAML.load(contents)['http_interactions'].first['response']['body']['string']
+    JSON.parse(body)['values'].first['id']
+  end
+
+  let(:field_id) do
+    contents = File.read('test/support/vcr/get_fields.yml')
+    body = YAML.load(contents)['http_interactions'].first['response']['body']['string']
+    JSON.parse(body)['values'].first['id']
+  end
+
+  let(:client) { JD::Client.new(API_KEY, API_SECRET, environment: :sandbox, access: [ACCESS_TOKEN, ACCESS_SECRET]) }
+  let(:accessor) { VCR.use_cassette('catalog') { client.send(:accessor) } }
+  let(:collection) { JD::Request::Collection::Flags.new(accessor, organization: organization_id, field: field_id) }
+
+  describe '#initialize(access_token)' do
+    it 'accepts an access token' do
+      assert_kind_of OAuth::AccessToken, collection.accessor
+    end
+
+    it 'accepts associations' do
+      collection = JD::Request::Collection::Flags.new(accessor, organization: '123', field: '456')
+
+      assert_kind_of Hash, collection.associations
+      assert_equal '123', collection.associations[:organization]
+      assert_equal '456', collection.associations[:field]
+    end
+  end
+
+  describe '#resource' do
+    it 'returns /organizations/{org_id}/fields/{field_id}/flags' do
+      assert_equal "/organizations/#{organization_id}/fields/#{field_id}/flags", collection.resource
+    end
+  end
+
+  describe '#all' do
+    it 'returns all records' do
+      all = VCR.use_cassette('get_flags', record: :new_episodes) { collection.all }
+
+      assert_kind_of Array, all
+      assert_equal collection.count, all.size
+
+      all.each do |item|
+        assert_kind_of JD::Model::Flag, item
+      end
+    end
+  end
+
+  describe '#count' do
+    let(:server_response) do
+      contents = File.read('test/support/vcr/get_flags.yml')
+      body = YAML.load(contents)['http_interactions'].first['response']['body']['string']
+      JSON.parse(body)
+    end
+
+    let(:server_count) { server_response['total'] }
+
+    it 'returns the total count of records in the collection' do
+      count = VCR.use_cassette('get_flags') { collection.count }
+
+      assert_equal server_count, count
+    end
+  end
+
+  describe 'results' do
+    let(:flag_geometries) do
+      contents = File.read('test/support/vcr/get_flags.yml')
+      body = YAML.load(contents)['http_interactions'].first['response']['body']['string']
+      JSON.parse(body)['values'].map{|v| JSON.parse(v['geometry'])}
+    end
+
+    it 'returns all records as a single enumerator' do
+      count = VCR.use_cassette('get_flags') { collection.count }
+      geometries = VCR.use_cassette('get_flags', record: :new_episodes) { collection.map{|item| item.geometry} }
+
+      assert_kind_of Array, geometries
+      assert_equal count, geometries.size
+
+      flag_geometries.each do |expected_geometry|
+        assert_includes geometries, expected_geometry
+      end
+    end
+  end
+end

data/test/lib/my_john_deere_api/request/{test_organizations.rb → collection/test_organizations.rb}

@@ -2,10 +2,10 @@ require 'support/helper'
 require 'yaml'
 require 'json'
 
-describe 'MyJohnDeereApi::Request::Organizations' do
+describe 'MyJohnDeereApi::Request::Collection::Organizations' do
   let(:client) { JD::Client.new(API_KEY, API_SECRET, environment: :sandbox, access: [ACCESS_TOKEN, ACCESS_SECRET]) }
   let(:accessor) { VCR.use_cassette('catalog') { client.send(:accessor) } }
-  let(:collection) { JD::Request::Organizations.new(accessor) }
+  let(:collection) { JD::Request::Collection::Organizations.new(accessor) }
 
   describe '#initialize(access_token)' do
     it 'accepts an access token' do

data/test/lib/my_john_deere_api/request/test_collection.rb

@@ -1,28 +1,21 @@
 require 'support/helper'
 
 describe 'MyJohnDeereApi::Request::Collection' do
-  let(:client) { JD::Client.new(API_KEY, API_SECRET, environment: :sandbox, access: [ACCESS_TOKEN, ACCESS_SECRET]) }
-  let(:accessor) { VCR.use_cassette('catalog') { client.send(:accessor) } }
-
-  describe '#initialize(access_token)' do
-    it 'accepts an access token' do
-      collection = JD::Request::Collection.new(accessor)
-      assert_kind_of OAuth::AccessToken, collection.accessor
+  describe 'loading dependencies' do
+    it 'loads Request::Collection::Base' do
+      assert JD::Request::Collection::Base
     end
 
-    it 'accepts associations' do
-      collection = JD::Request::Collection.new(accessor, organization: '123')
-
-      assert_kind_of Hash, collection.associations
-      assert_equal '123', collection.associations[:organization]
+    it 'loads Request::Collection::Organizations' do
+      assert JD::Request::Collection::Organizations
     end
-  end
 
-  it 'uses the Enumerable module' do
-    collection = JD::Request::Collection.new(accessor)
+    it 'loads Request::Collection::Fields' do
+      assert JD::Request::Collection::Fields
+    end
 
-    [:each, :first, :map, :detect, :select].each do |method_name|
-      assert collection.respond_to?(method_name)
+    it 'loads Request::Collection::Flags' do
+      assert JD::Request::Collection::Flags
     end
   end
-end
+end

data/test/lib/my_john_deere_api/test_errors.rb

@@ -0,0 +1,9 @@
+require 'support/helper'
+
+describe 'MyJohnDeereApi Errors' do
+  describe 'loading dependencies' do
+    it 'loads AccessTokenError' do
+      assert JD::AccessTokenError
+    end
+  end
+end

data/test/lib/my_john_deere_api/test_helpers.rb

@@ -5,5 +5,9 @@ describe 'MyJohnDeereApi::Helpers' do
     it 'loads Helpers::UriPath' do
       assert JD::Helpers::UriPath
     end
+
+    it 'loads Helpers::CaseConversion' do
+      assert JD::Helpers::CaseConversion
+    end
   end
 end

data/test/lib/my_john_deere_api/test_model.rb

@@ -9,5 +9,9 @@ describe 'MyJohnDeereApi::Model' do
     it 'loads Model::Field' do
       assert JD::Model::Field
     end
+
+    it 'loads Model::Flag' do
+      assert JD::Model::Flag
+    end
   end
 end

data/test/lib/my_john_deere_api/test_request.rb

@@ -5,13 +5,5 @@ describe 'MyJohnDeereApi::Request' do
     it 'loads Request::Collection' do
       assert JD::Request::Collection
     end
-
-    it 'loads Request::Organizations' do
-      assert JD::Request::Organizations
-    end
-
-    it 'loads Request::Fields' do
-      assert JD::Request::Fields
-    end
   end
 end

data/test/support/vcr/get_flags.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://sandboxapi.deere.com/platform/organizations/444563/fields/11911a5a-ff81-40ef-b10d-0af9457fe474/flags
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.deere.axiom.v3+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - OAuth gem v0.5.4
+      Authorization:
+      - OAuth oauth_consumer_key="johndeere-wgmADngYCRmfpEbVgSyc709wnyRux5J7PAv8SE7B",
+        oauth_nonce="dRV3ofkbPhDbjsPS2SpKYg5gUuiFuMnyw73JVhlYo", oauth_signature="Ksz7EKYSxTn9aDfwo48wNcUYoCQ%3D",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1578607741", oauth_token="47bbb9c9-41a8-4bec-8127-e3c5760af2f6",
+        oauth_version="1.0"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 09 Jan 2020 22:09:02 GMT
+      Content-Type:
+      - application/vnd.deere.axiom.v3+json;charset=UTF-8
+      X-Deere-Handling-Server:
+      - ip-10-214-44-105
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Deere-Elapsed-Ms:
+      - '52'
+      Cache-Control:
+      - no-store
+      Content-Language:
+      - en-US
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"links":[{"rel":"self","uri":"https://sandboxapi.deere.com/platform/organizations/444563/fields"}],"total":1,"values":[{"@type": "Flag","geometry": "{\"type\": \"Point\", \"coordinates\": [-93.14959274063109, 41.66881548411553] }","notes": "A big rock on the left after entering the field","metaData": [{"name": "HARVESTABILITY","value": 1},{"name": "STAND_COUNT","value": 1}],"archived": false,"proximityAlertEnabled": false,"links": [{"rel": "owningOrganization","uri": "https://sandboxapi.deere.com/platform/organizations/1234"},{"rel": "flagCategoryWithPrefrences","uri": "https://sandboxapi.deere.com/platform/flagCategories/47a229fc-aa09-4618-956c-1c29ae884326?embed=preferences"},{"rel": "createdBy","uri": "https://sandboxapi.deere.com/platform/users/johndeeresystem"},{"rel": "lastModifiedBy","uri": "https://sandboxapi.deere.com/platform/users/john"},{"rel": "field","uri": "https://sandboxapi.deere.com/platform/organizations/1234/fields/7b387eaa-187f-4bd8-acbc-c81748b6ad3b"}],"id": "688c20bb-9609-4590-95c9-649ba65c06df","createdTime": "2018-07-01T21:00:11Z","lastModifiedTime": "2018-07-01T21:10:10Z"}]}'
+    http_version:
+  recorded_at: Thu, 09 Jan 2020 22:09:02 GMT
+recorded_with: VCR 5.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_john_deere_api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jaime. Bellmyer
@@ -100,25 +100,36 @@ files:
 - lib/my_john_deere_api/client.rb
 - lib/my_john_deere_api/consumer.rb
 - lib/my_john_deere_api/errors.rb
+- lib/my_john_deere_api/errors/access_token_error.rb
 - lib/my_john_deere_api/helpers.rb
+- lib/my_john_deere_api/helpers/case_conversion.rb
 - lib/my_john_deere_api/helpers/uri_path.rb
 - lib/my_john_deere_api/model.rb
 - lib/my_john_deere_api/model/field.rb
+- lib/my_john_deere_api/model/flag.rb
 - lib/my_john_deere_api/model/organization.rb
 - lib/my_john_deere_api/request.rb
 - lib/my_john_deere_api/request/collection.rb
-- lib/my_john_deere_api/request/fields.rb
-- lib/my_john_deere_api/request/organizations.rb
+- lib/my_john_deere_api/request/collection/base.rb
+- lib/my_john_deere_api/request/collection/fields.rb
+- lib/my_john_deere_api/request/collection/flags.rb
+- lib/my_john_deere_api/request/collection/organizations.rb
 - lib/my_john_deere_api/version.rb
+- test/lib/my_john_deere_api/errors/test_access_token_error.rb
+- test/lib/my_john_deere_api/helpers/test_case_conversion.rb
 - test/lib/my_john_deere_api/helpers/test_uri_path.rb
 - test/lib/my_john_deere_api/model/test_field.rb
+- test/lib/my_john_deere_api/model/test_flag.rb
 - test/lib/my_john_deere_api/model/test_organization.rb
+- test/lib/my_john_deere_api/request/collection/test_base.rb
+- test/lib/my_john_deere_api/request/collection/test_fields.rb
+- test/lib/my_john_deere_api/request/collection/test_flags.rb
+- test/lib/my_john_deere_api/request/collection/test_organizations.rb
 - test/lib/my_john_deere_api/request/test_collection.rb
-- test/lib/my_john_deere_api/request/test_fields.rb
-- test/lib/my_john_deere_api/request/test_organizations.rb
 - test/lib/my_john_deere_api/test_authorize.rb
 - test/lib/my_john_deere_api/test_client.rb
 - test/lib/my_john_deere_api/test_consumer.rb
+- test/lib/my_john_deere_api/test_errors.rb
 - test/lib/my_john_deere_api/test_helpers.rb
 - test/lib/my_john_deere_api/test_model.rb
 - test/lib/my_john_deere_api/test_request.rb
@@ -128,6 +139,7 @@ files:
 - test/support/vcr/catalog.yml
 - test/support/vcr/get_access_token.yml
 - test/support/vcr/get_fields.yml
+- test/support/vcr/get_flags.yml
 - test/support/vcr/get_organizations.yml
 - test/support/vcr/get_request_token.yml
 - test/test_my_john_deere_api.rb