my_john_deere_api 2.4.1

data/lib/my_john_deere_api/net_http_retry.rb

@@ -0,0 +1,2 @@
+require 'my_john_deere_api/net_http_retry/decorator'
+require 'my_john_deere_api/net_http_retry/max_retries_exceeded_error'

data/lib/my_john_deere_api/net_http_retry/decorator.rb

@@ -0,0 +1,53 @@
+module MyJohnDeereApi
+  module NetHttpRetry
+    class Decorator
+      attr_reader :object, :request_methods, :retry_delay_exponent, :max_retries, :response_codes
+
+      DEFAULTS = {
+        request_methods:      [:get, :post, :put, :delete],
+        retry_delay_exponent: 2,
+        max_retries: 12,
+        response_codes: ['429', '503']
+      }
+
+      def initialize(object, options={})
+        @object = object
+
+        [:request_methods, :retry_delay_exponent, :max_retries].each do |option|
+          instance_variable_set(:"@#{option}", options[option] || DEFAULTS[option])
+        end
+
+        @response_codes = (options[:response_codes] || DEFAULTS[:response_codes]).map(&:to_s)
+      end
+
+      def request(method_name, *args)
+        retries = 0
+        result = object.send(method_name, *args)
+
+        while response_codes.include?(result.code)
+          if retries >= max_retries
+            raise MaxRetriesExceededError.new(method_name, "#{result.code} #{result.message}")
+          end
+
+          delay = [result['retry-after'].to_i, retry_delay_exponent ** retries].max
+          sleep(delay)
+
+          result = object.send(method_name, *args)
+          retries += 1
+        end
+
+        result
+      end
+
+      private
+
+      def method_missing(method_name, *args, &block)
+        if request_methods.include?(method_name)
+          request(method_name, *args)
+        else
+          object.send(method_name, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/my_john_deere_api/net_http_retry/max_retries_exceeded_error.rb

@@ -0,0 +1,20 @@
+module MyJohnDeereApi
+  module NetHttpRetry
+    ##
+    # This error is used when a single request has exceeded
+    # the number of retries allowed by NetHttpRetry::Decorator::MAX_RETRIES.
+
+    class MaxRetriesExceededError < StandardError
+
+      ##
+      # argument is a string which describes the attempted request
+
+      def initialize(request_method, response_message)
+        message = "Max retries exceeded for #{request_method.to_s.upcase} " +
+                  "request: #{response_message}"
+
+        super(message)
+      end
+    end
+  end
+end

data/lib/my_john_deere_api/request.rb

@@ -0,0 +1,6 @@
+module MyJohnDeereApi::Request
+  autoload :Collection,           'my_john_deere_api/request/collection'
+  autoload :Create,               'my_john_deere_api/request/create'
+  autoload :Individual,           'my_john_deere_api/request/individual'
+  autoload :Update,               'my_john_deere_api/request/update'
+end

data/lib/my_john_deere_api/request/collection.rb

@@ -0,0 +1,10 @@
+module MyJohnDeereApi::Request::Collection
+  autoload :Base,                       'my_john_deere_api/request/collection/base'
+  autoload :Assets,                     'my_john_deere_api/request/collection/assets'
+  autoload :AssetLocations,             'my_john_deere_api/request/collection/asset_locations'
+  autoload :ContributionProducts,       'my_john_deere_api/request/collection/contribution_products'
+  autoload :ContributionDefinitions,    'my_john_deere_api/request/collection/contribution_definitions'
+  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/collection/asset_locations.rb

@@ -0,0 +1,27 @@
+require 'json'
+
+module MyJohnDeereApi::Request
+  class Collection::AssetLocations < Collection::Base
+    ##
+    # The resource path for the first page in the collection
+
+    def resource
+      "/assets/#{associations[:asset]}/locations"
+    end
+
+    ##
+    # This is the class used to model the data
+
+    def model
+      MyJohnDeereApi::Model::AssetLocation
+    end
+
+    ##
+    # Create a new asset location
+
+    def create(attributes)
+      merged_attributes = attributes.merge(asset_id: associations[:asset])
+      Create::AssetLocation.new(client, merged_attributes).object
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'json'
+
+module MyJohnDeereApi::Request
+  class Collection::Assets < Collection::Base
+    ##
+    # The resource path for the first page in the collection
+
+    def resource
+      "/organizations/#{associations[:organization]}/assets"
+    end
+
+    ##
+    # This is the class used to model the data
+
+    def model
+      MyJohnDeereApi::Model::Asset
+    end
+
+    ##
+    # Create a new asset
+
+    def create(attributes)
+      merged_attributes = attributes.merge(organization_id: associations[:organization])
+      Create::Asset.new(client, merged_attributes).object
+    end
+
+    ##
+    # Retrieve an asset from JD
+
+    def find(asset_id)
+      Individual::Asset.new(client, asset_id).object
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+module MyJohnDeereApi
+  class Request::Collection::Base
+    include Enumerable
+    include Helpers::UriHelpers
+
+    attr_reader :client, :associations
+
+    ##
+    # client is the original client instance which contains
+    # the necessary config info.
+
+    def initialize(client, associations = {})
+      @client = client
+      @associations = associations
+      @items = []
+    end
+
+    ##
+    # client accessor
+
+    def accessor
+      return @accessor if defined?(@accessor)
+      @accessor = client&.accessor
+    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(client, record) }
+    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/collection/contribution_definitions.rb

@@ -0,0 +1,26 @@
+require 'json'
+
+module MyJohnDeereApi::Request
+  class Collection::ContributionDefinitions < Collection::Base
+    ##
+    # The resource path for the first page in the collection
+
+    def resource
+      "/contributionProducts/#{associations[:contribution_product]}/contributionDefinitions"
+    end
+
+    ##
+    # This is the class used to model the data
+
+    def model
+      MyJohnDeereApi::Model::ContributionDefinition
+    end
+
+    ##
+    # Retrieve an item from JD
+
+    def find(item_id)
+      Individual::ContributionDefinition.new(client, item_id).object
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'json'
+
+module MyJohnDeereApi::Request
+  class Collection::ContributionProducts < Collection::Base
+    ##
+    # The resource path for the first page in the collection
+
+    def resource
+      "/contributionProducts?clientControlled=true"
+    end
+
+    ##
+    # This is the class used to model the data
+
+    def model
+      MyJohnDeereApi::Model::ContributionProduct
+    end
+
+    ##
+    # Retrieve an item from JD
+
+    def find(item_id)
+      Individual::ContributionProduct.new(client, item_id).object
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'json'
+
+module MyJohnDeereApi::Request
+  class Collection::Fields < Collection::Base
+    ##
+    # The resource path for the first page in the collection
+
+    def resource
+      "/organizations/#{associations[:organization]}/fields"
+    end
+
+    ##
+    # This is the class used to model the data
+
+    def model
+      MyJohnDeereApi::Model::Field
+    end
+
+    ##
+    # Retrieve a field from JD
+
+    def find(field_id)
+      Individual::Field.new(client, field_id, organization: associations[:organization]).object
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+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
+
+    ##
+    # Create a new flag (NOT YET IMPLEMENTED)
+
+    def create(attributes)
+      raise NotImplementedError
+    end
+
+    ##
+    # Retrieve an flag from JD (NOT YET IMPLEMENTED)
+
+    def find(asset_id)
+      raise NotImplementedError
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'json'
+
+module MyJohnDeereApi::Request
+  class Collection::Organizations < Collection::Base
+    ##
+    # The resource path for the first page in the collection
+
+    def resource
+      '/organizations'
+    end
+
+    ##
+    # This is the class used to model the data
+
+    def model
+      MyJohnDeereApi::Model::Organization
+    end
+
+    ##
+    # Retrieve an organization from JD
+
+    def find(organization_id)
+      Individual::Organization.new(client, organization_id).object
+    end
+  end
+end

data/lib/my_john_deere_api/request/create.rb

@@ -0,0 +1,5 @@
+module MyJohnDeereApi::Request::Create
+  autoload :Base,             'my_john_deere_api/request/create/base'
+  autoload :Asset,            'my_john_deere_api/request/create/asset'
+  autoload :AssetLocation,    'my_john_deere_api/request/create/asset_location'
+end

data/lib/my_john_deere_api/request/create/asset.rb

@@ -0,0 +1,57 @@
+require 'json'
+
+module MyJohnDeereApi
+  class Request::Create::Asset < Request::Create::Base
+    include Validators::Asset
+    include Helpers::ValidateContributionDefinition
+
+    private
+
+    ##
+    # Retrieve newly created record
+
+    def fetch_record
+      path = response['location'].split('/platform').last
+      result = accessor.get(path, headers)
+
+      JSON.parse(result.body)
+    end
+
+    ##
+    # This is the class used to model the data
+
+    def model
+      Model::Asset
+    end
+
+    ##
+    # Path supplied to API
+
+    def resource
+      @resource ||= "/organizations/#{attributes[:organization_id]}/assets"
+    end
+
+    ##
+    # Request body
+
+    def request_body
+      return @body if defined?(@body)
+
+      validate_contribution_definition
+
+      @body = {
+        title: attributes[:title],
+        assetCategory: attributes[:asset_category],
+        assetType: attributes[:asset_type],
+        assetSubType: attributes[:asset_sub_type],
+        links: [
+          {
+            '@type' => 'Link',
+            'rel' => 'contributionDefinition',
+            'uri' => "#{accessor.consumer.site}/contributionDefinitions/#{client.contribution_definition_id}"
+          }
+        ]
+      }
+    end
+  end
+end