my_john_deere_api 2.4.1

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

@@ -0,0 +1,110 @@
+require 'date'
+
+module MyJohnDeereApi
+  class Request::Create::AssetLocation < Request::Create::Base
+    include Validators::AssetLocation
+
+    private
+
+    ##
+    # Set defaults and generate some attributes from others.
+    # Overridden from parent class.
+
+    def process_attributes
+      process_timestamp
+      process_geometry
+    end
+
+    ##
+    # Request body
+
+    def request_body
+      return @body if defined?(@body)
+
+      @body = [{
+        timestamp: attributes[:timestamp],
+        geometry: attributes[:geometry],
+        measurementData: attributes[:measurement_data]
+      }]
+    end
+
+    ##
+    # Custom-process timestamp
+
+    def process_timestamp
+      attributes[:timestamp] ||= Time.now.utc
+
+      attributes[:timestamp] = attributes[:timestamp].is_a?(String) ?
+        attributes[:timestamp] :
+        attributes[:timestamp].strftime('%Y-%m-%dT%H:%M:%SZ')
+    end
+
+    ##
+    # Custom-process geometry
+
+    def process_geometry
+      attributes[:geometry] = if attributes[:geometry]
+        attributes[:geometry].is_a?(String) ?
+          attributes[:geometry] :
+          attributes[:geometry].to_json
+      elsif attributes[:coordinates]
+        geometry_from_coordinates
+      end
+    end
+
+    ##
+    # Convert just coordinates into valid geometry hash
+
+    def geometry_from_coordinates
+      {
+        type: 'Feature',
+        geometry: {
+          geometries: [
+            coordinates: attributes[:coordinates],
+            type: 'Point'
+          ],
+          type: 'GeometryCollection'
+        }
+      }.to_json
+    end
+
+    ##
+    # Path supplied to API
+
+    def resource
+      @resource ||= "/assets/#{attributes[:asset_id]}/locations"
+    end
+
+    ##
+    # Retrieve newly created record
+
+    def fetch_record
+      # There is no endpoint to fetch a single location by id. We have to fetch
+      # them in bulk via the asset, but there could be thousands. We limit the 
+      # request to just the first record from the location list endpoint, since
+      # locations are returned newest to oldest.
+
+      path = response['location'].split('/platform').last
+      path += "?count=1"
+
+      result = accessor.get(path, headers)
+
+      JSON.parse(result.body)['values'].first
+    end
+
+    ##
+    # Create a new timestamp adjusted by X minutes
+
+    def timestamp_add(timestamp, seconds)
+      stamp = DateTime.parse(timestamp).to_time + seconds
+      stamp.to_datetime.strftime('%Y-%m-%dT%H:%M:%SZ')
+    end
+
+    ##
+    # This is the class used to model the data
+
+    def model
+      Model::AssetLocation
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+require 'json'
+
+module MyJohnDeereApi
+  class Request::Create::Base
+    include Validators::Base
+
+    attr_reader :client, :attributes, :response
+
+    ##
+    # Accepts a valid oAuth AccessToken, and a hash of attributes.
+
+    def initialize(client, attributes)
+      @client = client
+      @attributes = attributes
+
+      process_attributes
+    end
+
+    ##
+    # client accessor
+
+    def accessor
+      return @accessor if defined?(@accessor)
+      @accessor = client&.accessor
+    end
+
+    ##
+    # Make the request, if the instance is valid
+
+    def request
+      validate!
+
+      @response = accessor.post(resource, request_body.to_json, headers)
+    end
+
+    ##
+    # Object created by request
+
+    def object
+      return @object if defined?(@object)
+
+      request unless response
+
+      @object = model.new(client, fetch_record)
+    end
+
+    private
+
+    ##
+    # Convert inputs into working attributes. This allows us to auto-create
+    # some attributes from others, or set defaults, on a class-by-class basis.
+    # See Request::Create::AssetLocation for an example.
+
+    def process_attributes
+    end
+
+    ##
+    # Headers for POST request
+
+    def headers
+      @headers ||= {
+        'Accept'        => 'application/vnd.deere.axiom.v3+json',
+        'Content-Type'  => 'application/vnd.deere.axiom.v3+json'
+      }
+    end
+  end
+end

data/lib/my_john_deere_api/request/individual.rb

@@ -0,0 +1,8 @@
+module MyJohnDeereApi::Request::Individual
+  autoload :Base,                     'my_john_deere_api/request/individual/base'
+  autoload :Asset,                    'my_john_deere_api/request/individual/asset'
+  autoload :ContributionProduct,      'my_john_deere_api/request/individual/contribution_product'
+  autoload :ContributionDefinition,   'my_john_deere_api/request/individual/contribution_definition'
+  autoload :Field,                    'my_john_deere_api/request/individual/field'
+  autoload :Organization,             'my_john_deere_api/request/individual/organization'
+end

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

@@ -0,0 +1,19 @@
+require 'json'
+
+module MyJohnDeereApi::Request
+  class Individual::Asset < Individual::Base
+    ##
+    # The resource path for the first page in the collection
+
+    def resource
+      "/assets/#{id}"
+    end
+
+    ##
+    # This is the class used to model the data
+
+    def model
+      MyJohnDeereApi::Model::Asset
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+require 'json'
+
+module MyJohnDeereApi::Request
+  class Individual::Base
+    attr_reader :client, :id, :associations, :response
+
+    ##
+    # Initialize with a client, and asset id
+
+    def initialize(client, id, associations = {})
+      @client = client
+      @id = id
+      @associations = associations
+    end
+
+    ##
+    # client accessor
+
+    def accessor
+      return @accessor if defined?(@accessor)
+      @accessor = client&.accessor
+    end
+
+    ##
+    # The object being requested, an asset in this case
+
+    def object
+      return @object if defined?(@object)
+
+      request unless response
+      @object = model.new(client, JSON.parse(response.body))
+    end
+
+    private
+
+    ##
+    # Make the request
+
+    def request
+      @response = accessor.get(resource, headers)
+    end
+
+    ##
+    # Headers for GET request
+
+    def headers
+      @headers ||= {
+        'Accept'        => 'application/vnd.deere.axiom.v3+json',
+      }
+    end
+  end
+end

data/lib/my_john_deere_api/request/individual/contribution_definition.rb

@@ -0,0 +1,19 @@
+require 'json'
+
+module MyJohnDeereApi::Request
+  class Individual::ContributionDefinition < Individual::Base
+    ##
+    # The resource path for the first page in the collection
+
+    def resource
+      "/contributionDefinitions/#{id}"
+    end
+
+    ##
+    # This is the class used to model the data
+
+    def model
+      MyJohnDeereApi::Model::ContributionDefinition
+    end
+  end
+end

data/lib/my_john_deere_api/request/individual/contribution_product.rb

@@ -0,0 +1,19 @@
+require 'json'
+
+module MyJohnDeereApi::Request
+  class Individual::ContributionProduct < Individual::Base
+    ##
+    # The resource path for the first page in the collection
+
+    def resource
+      "/contributionProducts/#{id}"
+    end
+
+    ##
+    # This is the class used to model the data
+
+    def model
+      MyJohnDeereApi::Model::ContributionProduct
+    end
+  end
+end

data/lib/my_john_deere_api/request/individual/field.rb

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

data/lib/my_john_deere_api/request/individual/organization.rb

@@ -0,0 +1,19 @@
+require 'json'
+
+module MyJohnDeereApi::Request
+  class Individual::Organization < Individual::Base
+    ##
+    # The resource path for the first page in the collection
+
+    def resource
+      "/organizations/#{id}"
+    end
+
+    ##
+    # This is the class used to model the data
+
+    def model
+      MyJohnDeereApi::Model::Organization
+    end
+  end
+end

data/lib/my_john_deere_api/request/update.rb

@@ -0,0 +1,4 @@
+module MyJohnDeereApi::Request::Update
+  autoload :Base,                     'my_john_deere_api/request/update/base'
+  autoload :Asset,                    'my_john_deere_api/request/update/asset'
+end

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

@@ -0,0 +1,40 @@
+require 'json'
+
+module MyJohnDeereApi
+  class Request::Update::Asset < Request::Update::Base
+    include Validators::Asset
+    include Helpers::ValidateContributionDefinition
+
+    private
+
+    ##
+    # Path supplied to API
+
+    def resource
+      @resource ||= "/assets/#{attributes[:id]}"
+    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

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

@@ -0,0 +1,67 @@
+require 'json'
+
+module MyJohnDeereApi
+  class Request::Update::Base
+    include Validators::Base
+
+    attr_reader :client, :item, :attributes, :response
+
+    ##
+    # Accepts a valid oAuth AccessToken, the item to be updated, 
+    # and a hash of attributes.
+    #
+    # category/type/subtype must be a recognized combination as defined above.
+
+    def initialize(client, item, attributes)
+      @client = client
+      @item = item
+      @attributes = item.attributes.merge(attributes)
+
+      process_attributes
+    end
+
+    #
+    # client accessor
+
+    def accessor
+      return @accessor if defined?(@accessor)
+      @accessor = client&.accessor
+    end
+
+    ##
+    # Make the request, if the instance is valid
+
+    def request
+      validate!
+
+      @response = accessor.put(resource, request_body.to_json, headers)
+    end
+
+    ##
+    # Object, same as item for updates
+
+    def object
+      @object ||= item
+    end
+
+    private
+
+    ##
+    # Convert inputs into working attributes. This allows us to auto-create
+    # some attributes from others, or set defaults, on a class-by-class basis.
+    # See Request::Create::AssetLocation for an example.
+
+    def process_attributes
+    end
+
+    ##
+    # Headers for PUT request
+
+    def headers
+      @headers ||= {
+        'Accept'        => 'application/vnd.deere.axiom.v3+json',
+        'Content-Type'  => 'application/vnd.deere.axiom.v3+json'
+      }
+    end
+  end
+end