my_john_deere_api 0.12.4 → 0.12.6

data/test/support/vcr/{app_consumer.yml → url.yml}

@@ -14,24 +14,24 @@ http_interactions:
       User-Agent:
       - OAuth gem v0.5.4
       Authorization:
-      - OAuth oauth_consumer_key="johndeere-wgmADngYCRmfpEbVgSyc709wnyRux5J7PAv8SE7B",
-        oauth_nonce="hLAsNSIk6Q2d3ULD6bT6rVf10km1qN5edh9HvNUgSc", oauth_signature="wjrjTVSXWY3uanxn69Y251jDFn8%3D",
-        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1578174980", oauth_version="1.0"
+      - OAuth oauth_consumer_key="johndeere-0000000000000000000000000000000000000000",
+        oauth_nonce="000000000000000000000000000000000000000000", oauth_signature="0000000000000000000000000000",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1581028214", oauth_version="1.0"
   response:
     status:
       code: 200
       message: OK
     headers:
       Date:
-      - Sat, 04 Jan 2020 21:56:21 GMT
+      - Fri, 07 Feb 2020 04:28:52 GMT
       Content-Type:
       - application/vnd.deere.axiom.v3+json;charset=UTF-8
       X-Deere-Handling-Server:
-      - ip-10-214-44-80
+      - ip-10-214-44-29
       X-Frame-Options:
       - SAMEORIGIN
       X-Deere-Elapsed-Ms:
-      - '16'
+      - '19'
       Cache-Control:
       - no-store
       Content-Language:
@@ -42,5 +42,5 @@ http_interactions:
       encoding: ASCII-8BIT
       string: '{"@type":"ApiCatalog","links":[{"@type":"Link","rel":"oauthRequestToken","uri":"https://sandboxapi.deere.com/platform/oauth/request_token"},{"@type":"Link","rel":"oauthAuthorizeRequestToken","uri":"https://my.deere.com/consentToUseOfData?oauth_token={token}"},{"@type":"Link","rel":"oauthAccessToken","uri":"https://sandboxapi.deere.com/platform/oauth/access_token"},{"@type":"Link","rel":"agencies","uri":"https://sandboxapi.deere.com/platform/agencies"}]}'
     http_version: 
-  recorded_at: Sat, 04 Jan 2020 21:56:21 GMT
+  recorded_at: Fri, 07 Feb 2020 04:28:53 GMT
 recorded_with: VCR 5.0.0

data/test/support/vcr/warning.txt

@@ -0,0 +1,24 @@
+-------------------------------------------------------------------------------
+WARNING: Generating VCR cassettes requires the following in your John Deere
+API sandbox account:
+
+- You must have asset creation/deletion enabled in your account.
+- You must have at least one organization created.
+- The organization must have at least one field.
+- The field must have at least one flag.
+
+By default, this setup will use the first organization returned from the API.
+If this is not the organization you wish to use, you can create an environment
+variable ORGANIZATION_ID which contains the id of the organization you wish to
+use. This organization must contain a field, which contains a flag.
+
+This is required because organizations cannot be created via the API, and
+fields and flags can be created but not destroyed via the API. We don't create
+anything during VCR cassette recording that we can't undo. This process will
+leave your sandbox environment in the exact state it was before the cassettes
+were generated.
+
+If you don't meet the above requirements, you will be unable to successfully
+generate the VCR cassettes.
+-------------------------------------------------------------------------------
+

data/test/support/vcr_setup.rb

@@ -0,0 +1,420 @@
+require 'vcr'
+require 'yaml'
+require 'json'
+require 'date'
+
+##########################################################################
+# We're going to make a bunch of requests upfront so we can create/delete
+# things in the correct order, and end up with no permanent changes to the
+# sandbox environment. We only need to do this pre-emptively for resources
+# where we create/delete. We build the client from scratch to get the full
+# interaction history recorded.
+##########################################################################
+
+class VcrSetup
+  attr_reader :api_key, :api_secret, :access_token, :access_secret, :verify_code,
+              :contribution_product_id, :contribution_definition_id,
+              :placeholders, :organization_id, :asset_id, :field_id, :flag_id
+
+  GENERATED_CASSETTES = [
+    :catalog, :get_request_token, :get_access_token,
+    :get_contribution_products, :get_contribution_product,
+    :get_organizations, :get_organization,
+    :get_fields, :get_flags,
+    :post_assets, :get_assets, :get_asset,
+    :post_asset_locations, :get_asset_locations,
+    :delete_asset
+  ]
+
+  def initialize
+    @vcr_dir = File.dirname(__FILE__) + '/vcr'
+
+    # Before we configure VCR, we want to make a few requests to set some constants
+    @client = new_client
+
+    # placeholders
+    @uuid = '00000000-0000-0000-0000-000000000000'
+    @api_key = 'johndeere-0000000000000000000000000000000000000000'
+    @api_secret = '0' * 64
+    @access_token = @uuid
+    @access_secret = '0' * 107 + '='
+    @contribution_product_id = @uuid
+    @contribution_definition_id = @uuid
+    @organization_id = '000000'
+    @asset_id = @uuid
+    @field_id = @uuid
+    @flag_id = @uuid
+    @verify_code = 'VERIFY'
+
+    @placeholders = {
+      API_KEY => @api_key,
+      API_SECRET => @api_secret,
+      ACCESS_TOKEN => @access_token,
+      ACCESS_SECRET => @access_secret
+    }
+
+    unless all_cassettes_generated? || meets_vcr_requirements?
+      raise "Cannot continue until VCR cassettes can be generated."
+    end
+
+    set_contribution_product_id
+    set_contribution_definition_id
+    set_organization_id
+
+    configure_vcr
+
+    url
+
+    # create and retrieve things
+    unless all_cassettes_generated?
+      puts "\ngenerating:"
+
+      GENERATED_CASSETTES.each do |method_name|
+        filename = "#{method_name}.yml"
+
+        if File.exist?("#{@vcr_dir}/#{filename}")
+          puts " - using #{filename}"
+        else
+          puts " - generating #{filename}"
+          VCR.use_cassette(method_name) { send(method_name) }
+        end
+      end
+    end
+
+    sanitize_files
+  end
+
+  # provide a client with sanitized credentials
+  def client
+    JD::Client.new(api_key, api_secret, environment: :sandbox, access: [access_token, access_secret])
+  end
+
+  def timestamp
+    return @timestamp if defined?(@timestamp)
+
+    filename = "#{@vcr_dir}/get_asset_locations.yml"
+
+    @timestamp = if File.exist?(filename)
+      contents = File.read('test/support/vcr/get_asset_locations.yml')
+      body = YAML.load(contents)['http_interactions'].last['response']['body']['string']
+      JSON.parse(body)['values'].last['timestamp']
+    else
+      Time.now.strftime('%Y-%m-%dT%H:%M:%S.000Z')
+    end
+  end
+
+  def epoch_timestamp
+    return @epoch_timestamp if defined?(@epoch_timestamp)
+    @epoch_timestamp = DateTime.parse(timestamp).to_time.to_i
+  end
+
+  def coordinates
+    @coordinates ||= [-96.668978, 40.865984]
+  end
+
+  def geometry
+    @geometry ||= {
+      type: 'Feature',
+      geometry: {
+        geometries: [
+          coordinates: coordinates,
+          type: 'Point'
+        ],
+        type: 'GeometryCollection'
+      }
+    }
+  end
+
+  def measurement_data
+    @measurement_data ||= [
+      {
+        name: 'Temperature',
+        value: '68.0',
+        unit: 'F'
+      }
+    ]
+  end
+
+  def asset_attributes
+    @asset_attributes ||= {
+      contribution_definition_id: ENV['CONTRIBUTION_DEFINITION_ID'],
+      title: 'Asset Title',
+      asset_category: 'DEVICE',
+      asset_type: 'SENSOR',
+      asset_sub_type: 'ENVIRONMENTAL',
+      links: [
+        {
+          '@type' => 'Link',
+          'rel' => 'contributionDefinition',
+          'uri' => "#{url}/contributionDefinitions/#{ENV['CONTRIBUTION_DEFINITION_ID']}"
+        }
+      ]
+    }.freeze
+  end
+
+  def asset_location_attributes
+    @asset_location_attributes ||= {
+      timestamp: timestamp,
+      geometry: geometry,
+      measurement_data: measurement_data
+    }.freeze
+  end
+
+  private
+
+  def all_cassettes_generated?
+    return @all_cassettes_generated if defined?(@all_cassettes_generated)
+    @all_cassettes_generated = GENERATED_CASSETTES.all?{|cassette| File.exist?("#{@vcr_dir}/#{cassette}.yml") }
+  end
+
+  # provide a fresh client with no memoized requests
+  def new_client
+    JD::Client.new(API_KEY, API_SECRET, environment: :sandbox, access: [ACCESS_TOKEN, ACCESS_SECRET])
+  end
+
+  def url
+    return @url if defined?(@url)
+    @url = VCR.use_cassette('url'){ new_client.send(:accessor).consumer.site }
+  end
+
+  def catalog
+    new_client.get('/')
+  end
+
+  def get_request_token
+    @temporary_authorize = JD::Authorize.new(API_KEY, API_SECRET, environment: :sandbox)
+    @temporary_authorize_url = @temporary_authorize.authorize_url
+  end
+
+  def get_access_token
+    puts "\n\n----\nFOLLOW THIS LINK, AND ENTER THE VERIFICATION CODE:\n#{@temporary_authorize_url}\n----\n\n"
+    $stdout.print 'Verification Code: '; $stdout.flush
+    code = $stdin.gets.chomp
+    puts
+
+    placeholders[code] = verify_code
+
+    @temporary_authorize.verify(code)
+  end
+
+  def get_contribution_products
+    new_client.get('/contributionProducts?clientControlled=true')
+  end
+
+  def get_organizations
+    new_client.organizations.all
+  end
+
+  def get_organization
+    new_client.get("/organizations/#{ENV['ORGANIZATION_ID']}")
+  end
+
+  def get_fields
+    @temporary_field = find_organization(ENV['ORGANIZATION_ID']).fields.all.first
+  end
+
+  def get_flags
+    @temporary_field.flags.all
+  end
+
+  def get_contribution_product
+    new_client.get("/contributionProducts/#{ENV['CONTRIBUTION_PRODUCT_ID']}")
+  end
+
+  def post_assets
+    @temporary_asset_id = find_organization(ENV['ORGANIZATION_ID']).assets.create(asset_attributes).id
+    placeholders[@temporary_asset_id] = asset_id
+  end
+
+  def get_assets
+    find_organization(ENV['ORGANIZATION_ID']).assets.all
+  end
+
+  def get_asset
+    find_organization(ENV['ORGANIZATION_ID']).assets.find(@temporary_asset_id)
+  end
+
+  def delete_asset
+    new_client.delete("/assets/#{@temporary_asset_id}")
+  end
+
+  def post_asset_locations
+    find_asset(ENV['ORGANIZATION_ID'], @temporary_asset_id).locations.create(asset_location_attributes)
+  end
+
+  def get_asset_locations
+    find_asset(ENV['ORGANIZATION_ID'], @temporary_asset_id).locations.all
+  end
+
+  def configure_vcr
+    VCR.configure do |config|
+      config.cassette_library_dir = 'test/support/vcr'
+      config.hook_into :webmock
+      config.default_cassette_options = {record: :once}
+    end
+  end
+
+  def sanitize_files
+    Dir[File.dirname(__FILE__) + "/vcr/**/*.yml"].each do |filename|
+      text = sanitize_text(File.read(filename))
+
+      data = YAML.load(text)
+      sanitize_yaml!(data)
+
+      File.write(filename, data.to_yaml)
+    end
+  end
+
+  def sanitize_text(text)
+    data = text
+
+    placeholders.each do |value, placeholder|
+      data.gsub!(value, placeholder)
+    end
+
+    # organization links
+    data.gsub!(/\/organizations\/[0-9]+/, "/organizations/#{organization_id}")
+
+    # random ids
+    data.gsub!(/"id":"[0-9]+"/, '"id":"000000"')
+
+    # uuids
+    data.gsub!(/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/, @uuid)
+
+    # timestamps
+    data.gsub!(/[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}Z/, timestamp)
+    data.gsub!(/1[4567][0-9]{8}/, epoch_timestamp.to_s)
+
+    # geo coordinates
+    data.gsub!(/\[-{0,1}[0-9]{1,3}\.[0-9]{6},-{0,1}[0-9]{1,3}\.[0-9]{6}\]/, coordinates.to_s.gsub(' ', ''))
+
+    # oauth headers
+    data.gsub!(/oauth_nonce="[0-9a-zA-Z]+"/, 'oauth_nonce="000000000000000000000000000000000000000000"')
+    data.gsub!(/oauth_signature="[0-9a-zA-Z%]+"/, 'oauth_signature="0000000000000000000000000000"')
+    data.gsub!(/oauth_token_secret=[0-9a-zA-Z%]+/, 'oauth_token_secret=000000000000000000000000000000000000000000')
+    data.gsub!(/oauth_verifier="[0-9A-Za-z]{6}"/, 'oauth_verifier="VERIFY"')
+
+    data
+  end
+
+  def sanitize_yaml!(data)
+    if data.is_a?(Array)
+      data.each { |item| sanitize_yaml!(item) }
+    elsif data.is_a?(Hash)
+      data.each do |key, value|
+        if key == 'string'
+          data[key] = sanitize_response_body(value)
+        else
+          sanitize_yaml!(value)
+        end
+      end
+    end
+  end
+
+  def sanitize_response_body(string)
+    data = nil
+
+    # if this isn't JSON, just return the original string
+    begin
+      data = JSON.parse(string)
+    rescue JSON::ParserError
+      return string
+    end
+
+    # various response body attributes
+    if data.is_a?(Hash)
+      if data['values']
+        data['values'].each do |value|
+          value = sanitize_value(value)
+        end
+      elsif data['@type']
+        data = sanitize_value(data)
+      end
+    elsif data.is_a?(Array)
+      data.each do |value|
+        # nothing yet
+      end
+    end
+
+    data.to_json
+  end
+
+  def sanitize_value(value)
+    merge_hash = case value['@type']
+    when 'Organization'
+      {'name' => 'Organization Name'}
+    when 'ContributionProduct'
+      {
+        'marketPlaceName' => 'Market Place Name',
+        'marketPlaceDescription' => 'Market Place Description'
+      }
+    when 'ContributedAsset'
+      {
+        'title' => 'Asset Title',
+        'assetCategory' => 'DEVICE',
+        'assetType' => 'SENSOR',
+        'assetSubType' => 'ENVIRONMENTAL'
+      }
+    when 'Field'
+      {'name' => 'Field Name'}
+    else
+      {}
+    end
+
+    value.merge!(merge_hash)
+  end
+
+  def set_contribution_product_id
+    unless ENV['CONTRIBUTION_PRODUCT_ID']
+      set_env(
+        'CONTRIBUTION_PRODUCT_ID',
+        client.get('/contributionProducts?clientControlled=true')['values'].first['id']
+      )
+    end
+
+    placeholders[ENV['CONTRIBUTION_PRODUCT_ID']] = contribution_product_id
+  end
+
+  def set_contribution_definition_id
+    unless ENV['CONTRIBUTION_DEFINITION_ID']
+      set_env(
+        'CONTRIBUTION_DEFINITION_ID',
+        client.get("/contributionProducts/#{ENV['CONTRIBUTION_PRODUCT_ID']}/contributionDefinitions")['values'].first['id']
+      )
+    end
+
+    placeholders[ENV['CONTRIBUTION_DEFINITION_ID']] = contribution_definition_id
+  end
+
+  def set_organization_id
+    unless ENV['ORGANIZATION_ID']
+      set_env(
+        'ORGANIZATION_ID',
+        client.get("/organizations")['values'].first['id']
+      )
+    end
+
+    placeholders[ENV['ORGANIZATION_ID']] = organization_id
+  end
+
+  def set_env(name, value)
+    ENV[name] = value
+    File.open('.env', 'a') { |f| f.puts "#{name}=#{value}"}
+  end
+
+  def find_organization(id)
+    new_client.organizations.detect{|org| org.id == id}
+  end
+
+  def find_asset(org_id, id)
+    find_organization(org_id).assets.detect{|asset| asset.id == id}
+  end
+
+  def meets_vcr_requirements?
+    puts File.read("#{@vcr_dir}/warning.txt")
+    $stdout.print("Do you meet the requirements? [y/N]: "); $stdout.flush
+
+    answer = $stdin.gets.chomp
+    answer.downcase == 'y'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_john_deere_api
 version: !ruby/object:Gem::Version
-  version: 0.12.4
+  version: 0.12.6
 platform: ruby
 authors:
 - Jaime Bellmyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-29 00:00:00.000000000 Z
+date: 2020-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -119,6 +119,7 @@ files:
 - lib/my_john_deere_api/model/asset.rb
 - lib/my_john_deere_api/model/asset_location.rb
 - lib/my_john_deere_api/model/base.rb
+- lib/my_john_deere_api/model/contribution_product.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
@@ -127,6 +128,7 @@ files:
 - lib/my_john_deere_api/request/collection/asset_locations.rb
 - lib/my_john_deere_api/request/collection/assets.rb
 - lib/my_john_deere_api/request/collection/base.rb
+- lib/my_john_deere_api/request/collection/contribution_products.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
@@ -137,6 +139,7 @@ files:
 - lib/my_john_deere_api/request/individual.rb
 - lib/my_john_deere_api/request/individual/asset.rb
 - lib/my_john_deere_api/request/individual/base.rb
+- lib/my_john_deere_api/request/individual/contribution_product.rb
 - lib/my_john_deere_api/version.rb
 - test/lib/my_john_deere_api/authorize_test.rb
 - test/lib/my_john_deere_api/client_test.rb
@@ -153,6 +156,7 @@ files:
 - test/lib/my_john_deere_api/model/asset_location_test.rb
 - test/lib/my_john_deere_api/model/asset_test.rb
 - test/lib/my_john_deere_api/model/base_test.rb
+- test/lib/my_john_deere_api/model/contribution_product_test.rb
 - test/lib/my_john_deere_api/model/field_test.rb
 - test/lib/my_john_deere_api/model/flag_test.rb
 - test/lib/my_john_deere_api/model/organization_test.rb
@@ -160,6 +164,7 @@ files:
 - test/lib/my_john_deere_api/request/collection/asset_locations_test.rb
 - test/lib/my_john_deere_api/request/collection/assets_test.rb
 - test/lib/my_john_deere_api/request/collection/base_test.rb
+- test/lib/my_john_deere_api/request/collection/contribution_products_test.rb
 - test/lib/my_john_deere_api/request/collection/fields_test.rb
 - test/lib/my_john_deere_api/request/collection/flags_test.rb
 - test/lib/my_john_deere_api/request/collection/organizations_test.rb
@@ -170,25 +175,30 @@ files:
 - test/lib/my_john_deere_api/request/create_test.rb
 - test/lib/my_john_deere_api/request/individual/asset_test.rb
 - test/lib/my_john_deere_api/request/individual/base_test.rb
+- test/lib/my_john_deere_api/request/individual/contribution_product_test.rb
 - test/lib/my_john_deere_api/request/individual_test.rb
 - test/lib/my_john_deere_api/request_test.rb
 - test/lib/my_john_deere_api/version_test.rb
 - test/my_john_deere_api_test.rb
 - test/support/helper.rb
-- test/support/vcr/app_consumer.yml
 - test/support/vcr/catalog.yml
 - test/support/vcr/delete_asset.yml
 - test/support/vcr/get_access_token.yml
 - test/support/vcr/get_asset.yml
 - test/support/vcr/get_asset_locations.yml
 - test/support/vcr/get_assets.yml
+- test/support/vcr/get_contribution_product.yml
+- test/support/vcr/get_contribution_products.yml
 - test/support/vcr/get_fields.yml
 - test/support/vcr/get_flags.yml
+- test/support/vcr/get_organization.yml
 - test/support/vcr/get_organizations.yml
 - test/support/vcr/get_request_token.yml
 - test/support/vcr/post_asset_locations.yml
 - test/support/vcr/post_assets.yml
-- test/support/vcr/post_flag_categories.yml
+- test/support/vcr/url.yml
+- test/support/vcr/warning.txt
+- test/support/vcr_setup.rb
 homepage: https://github.com/Intellifarm/my_john_deere_api
 licenses:
 - MIT

data/test/support/vcr/post_flag_categories.yml

@@ -1,49 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://sandboxapi.deere.com/platform/organizations/444563/flagCategories
-    body:
-      encoding: UTF-8
-      string: '{"@type":"FlagCategory","categoryTitle":"Mountain Dew","sourceNode":"7ba95d7a-f798-46d0-9bf9-c39c31bcf984","links":[{"rel":"contributionDefinition","uri":"https://sandboxapi.deere.com/platform/contributionDefinitions/d93611c7-6f74-474f-9569-2cf88f866a32"}],"preferred":true}'
-    headers:
-      Accept:
-      - application/vnd.deere.axiom.v3+json
-      Content-Type:
-      - 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
-      Content-Length:
-      - '274'
-      Authorization:
-      - OAuth oauth_body_hash="aNgumBwEzeKYfLOtt5eKxESOxZw%3D", oauth_consumer_key="johndeere-wgmADngYCRmfpEbVgSyc709wnyRux5J7PAv8SE7B",
-        oauth_nonce="wTCf5Hv2r9t83Zfm7DkZaRQleb9TAz5Y1aeVElSU08", oauth_signature="arrFHdesSS315MPGWJWz%2FCYbrLE%3D",
-        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1579215133", oauth_token="47bbb9c9-41a8-4bec-8127-e3c5760af2f6",
-        oauth_version="1.0"
-  response:
-    status:
-      code: 409
-      message: Conflict
-    headers:
-      Date:
-      - Thu, 16 Jan 2020 22:52:13 GMT
-      X-Deere-Handling-Server:
-      - ip-10-214-45-154
-      X-Frame-Options:
-      - SAMEORIGIN
-      Location:
-      - https://sandboxapi.deere.com/platform/flagCategories/b57110f3-0297-461c-81aa-d3b16e111d4d
-      X-Deere-Elapsed-Ms:
-      - '420'
-      Content-Length:
-      - '0'
-      Connection:
-      - close
-    body:
-      encoding: UTF-8
-      string: ''
-    http_version: 
-  recorded_at: Thu, 16 Jan 2020 22:52:14 GMT
-recorded_with: VCR 5.0.0