myjohndeere 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69d83496b40f9f3572eb474f5b39dc257e6fd5ad
+  data.tar.gz: f2714c4b6ea7b99e9d82ce75a89c972c85456b4d
+SHA512:
+  metadata.gz: a2ca3525d62c644406162c3f1fb1b9ee057443958d00ee2110848e5ba10b911dec04962f3b3cde41328284891a93de810acb1feda093d585f5c1b04d46693dbe
+  data.tar.gz: 967b2056c8c55902150d88407453580d48997cd30abdf71e6c9f8f480e6cff38d5a24c849491b4f5da22cbd15fa1a7e0b46ddf3cf56f4beca8b8dcda8ba7b631

data/.gitignore

@@ -0,0 +1,52 @@
+*agribotix*
+*.gem
+*.rbc
+*.byebug*
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem 'minitest'
+  gem 'webmock'
+  gem 'rake'
+  platforms :mri do
+    # to avoid problems, bring Byebug in on just versions of Ruby under which
+    # it's known to work well
+    if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.0.0')
+      gem 'byebug'
+    end
+  end
+end

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    myjohndeere (0.0.1)
+      oauth (>= 0.5.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    byebug (9.0.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    hashdiff (0.3.2)
+    minitest (5.8.4)
+    oauth (0.5.3)
+    public_suffix (2.0.5)
+    rake (11.3.0)
+    safe_yaml (1.0.4)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  minitest
+  myjohndeere!
+  rake
+  webmock
+
+BUNDLED WITH
+   1.13.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Paul Susmarski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+# MyJohnDeere API Library
+
+The MyJohnDeere Ruby library provides convenient access to the MyJohnDeere API from applications written in the Ruby language. It includes a pre-defined set of classes for API resources that are available currently from the API. You will need to get access by going to the [JohnDeere Developer page](https://developer.deere.com/#!welcome). The interface utilizes OAUTH 1.0.
+
+## Usage
+
+### Configuration
+
+The library needs to be configured with your MyJohnDeere account's shared secret & app id. These will be available on the developer page at JohnDeere.
+
+``` ruby
+require "myjohndeere"
+
+MyJohnDeere.configure do |config|
+  config.environment = :sandbox # :production is the other option
+  config.shared_secret = "...."
+  config.app_id = "johndeere-...."
+  # config.contribution_definition_id = "...." # not required for all requests
+  #config.log_level = :info
+end
+
+```
+
+The `contribution_definition_id` is used for a subset of requests, usually when you are adding resources to a map or otherwise. You can get this by contacting [JohnDeere Dev Support](APIDevSupport@johndeere.com) An error will be raised if this is missing for a certain request.
+
+### Get an Access Token
+
+**NOTE:** These expire after one year
+
+#### Access Token from Request Token
+If you are beginning from scratch then you'll be starting with a request token and the request token secret. To do this:
+
+
+``` ruby
+
+request_token = MyJohnDeere::AccessToken.get_request_token()
+puts "Now visit the #{request_token.authorize_url}"
+puts "Use the #{request_token.secret} and #{request_token.token} when creating the "
+puts "access token along with the verifier code from the browser"
+
+```
+
+Then later:
+``` ruby
+
+access_token = MyJohnDeere::AccessToken.new(request_token_token: "....", 
+    request_token_secret: "....",
+    verifier_code: "....")
+ # You'll now have the oauth access tokens
+puts access_token.token
+puts access_token.secret
+
+```
+
+#### Access Token from Existing OAuth Token
+
+If you've already gone through the effort to get your OAuth access token, then you can do:
+
+``` ruby
+access_token = MyJohnDeere::AccessToken.new(
+      oauth_access_token_token: "....",
+      oauth_access_token_secret: "....",
+    )
+```
+### Getting Objects
+
+Assuming you've created a MyJohnDeere::AccessToken using something from above, then you can do:
+
+``` ruby
+organizations = MyJohnDeere::Organization.list(access_token)
+
+organizations.each do |organization|
+    puts organization.fields.data
+end
+
+organizations.has_more?
+
+```
+
+## Listable Objects
+
+MyJohnDeere returns either pages of objects that will automatically be iterated through 10 at a time *or* you'll receive the entirety of the resource if you specify an etag token. **The default behavior is for pagination.**
+
+**If using the paginated approach**: Use `more_pages?` on the listable object to see if there are more pages to be acquired by using `next_page!`. This will modify the `.start` and `.count` values on the list object. These automatically increase with each `next_page`.
+
+**If using the etag approach**: The entirety of the data set will be returned to you and on the list object you'll want to call `list.etag` and store this locally. You can then use this on future requests to see if anything has changed from the original request.
+
+If you for some reason specify both, the etag will be the assumed behavior.
+
+The raw data can be acquired by using `.data` on a listable object.
+
+
+## Development
+
+Run all tests:
+
+    bundle exec rake
+
+Run a single test suite:
+
+    bundle exec ruby -Ilib/ test/myjohndeere_test.rb
+
+Run a single test:
+
+    bundle exec ruby -Ilib/ test/myjohndeere_test.rb -n /some_test/
+
+## Disclaimer
+
+This Gem is in no way associated with JohnDeere, and they are in no way associated with it's support, maintenance, or updates.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = './test/**/test_*.rb'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/myjohndeere.rb

@@ -0,0 +1,132 @@
+require 'net/http'
+require 'json'
+require 'rbconfig'
+require 'base64'
+require 'oauth'
+require 'logger'
+
+# Core extensions
+require 'myjohndeere/core_ext/string'
+
+# Errors
+require 'myjohndeere/errors'
+
+# Version
+require 'myjohndeere/version'
+
+# API Support Classes
+require 'myjohndeere/rest_methods'
+require 'myjohndeere/json_attributes'
+require 'myjohndeere/requestable'
+require 'myjohndeere/util'
+require 'myjohndeere/hash_utils'
+require 'myjohndeere/response'
+require 'myjohndeere/access_token'
+require 'myjohndeere/list_object'
+require 'myjohndeere/single_resource'
+require 'myjohndeere/organization_owned_resource'
+require 'myjohndeere/api_support_item'
+
+# API Sub-classes
+require 'myjohndeere/map_legend_item'
+require 'myjohndeere/metadata_item'
+
+# API Objects
+require 'myjohndeere/organization'
+require 'myjohndeere/field'
+require 'myjohndeere/boundary'
+require 'myjohndeere/map_layer_summary'
+require 'myjohndeere/map_layer'
+require 'myjohndeere/file_resource'
+
+module MyJohnDeere
+  class << self
+    attr_accessor :configuration
+    def set_logger()
+      @logger ||= Logger.new(STDOUT)
+      @logger.level = Logger.const_get(self.configuration.log_level.to_s.upcase)
+    end
+
+    def logger
+      if @logger.nil? then
+        set_logger()
+      end
+      @logger
+    end
+  end
+
+  JSON_CONTENT_HEADER_VALUE = 'application/vnd.deere.axiom.v3+json'
+  ENDPOINTS = {
+    sandbox: "https://sandboxapi.deere.com/platform",
+    production: "https://api.soa-proxy.deere.com/platform"
+  }.freeze
+  AUTHORIZE_URL = "https://my.deere.com/consentToUseOfData"
+  DEFAULT_REQUEST_HEADER = { 'accept'=> JSON_CONTENT_HEADER_VALUE }.freeze
+  DEFAULT_POST_HEADER = { 
+    'accept'=> JSON_CONTENT_HEADER_VALUE,
+    "Content-Type"=> JSON_CONTENT_HEADER_VALUE
+  }.freeze
+  ETAG_HEADER_KEY = "X-Deere-Signature"
+  REQUEST_METHODS_TO_PUT_PARAMS_IN_URL = [:get, :delete, :head]
+  SPECIAL_BODY_PARAMETERS = [:start, :count]
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+    set_logger()
+  end
+
+  class Configuration
+    attr_accessor :endpoint
+    attr_writer :shared_secret, :app_id, :contribution_definition_id
+    attr_reader :environment
+
+    def log_level=(val)
+      @log_level = val
+    end
+
+    def log_level
+      @log_level ||= :fatal
+      return @log_level
+    end
+
+    def environment=(val)
+      @environment = val.to_sym
+      @endpoint = ENDPOINTS[@environment]
+      if @endpoint.nil?
+        raise ConfigurationError.new('Invalid environment, you must use either :sandbox or :production. Sandbox is the default')
+      end
+    end
+
+    def initialize
+      # Assume the sandbox endpoint
+      self.environment = :sandbox
+      @shared_secret = nil
+      @app_id = nil
+    end
+
+    def contribution_definition_id
+      if @contribution_definition_id.nil? then
+        raise ConfigurationError.new('No contribution_definition_id provided in configuration. ' \
+          'Please set this to make the request, you\'ll need to contact JohnDeere support to get this value.')
+      end
+      return @contribution_definition_id
+    end
+
+    def shared_secret
+      if @shared_secret.nil? then
+        raise ConfigurationError.new('No shared_secret provided in configuration. ' \
+          'Please set this according to your Deere Developer app credentials.')
+      end
+      return @shared_secret
+    end
+
+    def app_id
+      if @app_id.nil? then
+        raise ConfigurationError.new('No app_id provided in configuration. ' \
+          'Please set this according to your Deere Developer app credentials.')
+      end
+      return @app_id
+    end
+  end
+end

data/lib/myjohndeere/access_token.rb

@@ -0,0 +1,79 @@
+module MyJohnDeere
+  class AccessToken
+    attr_accessor :oauth_access_token
+
+    def self.oauth_consumer(options = {})
+      OAuth::Consumer.new(
+        MyJohnDeere.configuration.app_id, 
+        MyJohnDeere.configuration.shared_secret,
+        options.merge(
+          site: MyJohnDeere.configuration.endpoint,
+          header: {Accept: MyJohnDeere::JSON_CONTENT_HEADER_VALUE}
+          ))
+    end
+
+    # Use this if you need to get the verifier code. You'll need to use this
+    # along with the request_token.authorize_url to have the user sign in and
+    # provide you with a verifier code. Makes a request to get the request_token.
+    def self.get_request_token()
+      consumer = self.oauth_consumer(
+        authorize_url: MyJohnDeere::AUTHORIZE_URL,
+        http_method: :get
+      )
+      return consumer.get_request_token({})
+    end
+
+    def initialize(options = {})
+      request_token_options = [:request_token_token, :request_token_secret, :verifier_code]
+      oauth_token_options = [:oauth_access_token_token, :oauth_access_token_secret]
+      if request_token_options.all? { |i| options.key?(i) } then
+        request_token = OAuth::RequestToken.from_hash(self.class.oauth_consumer, {
+          oauth_token: options[:token],
+          oauth_token_secret: options[:token_secret]
+        })
+        self.oauth_access_token = request_token.get_access_token(oauth_verifier: options[:verifier_code])
+      elsif oauth_token_options.all? { |i| options.key?(i) } then
+        self.oauth_access_token = OAuth::AccessToken.from_hash(
+          self.class.oauth_consumer, 
+          {
+            oauth_token: options[:oauth_access_token_token],
+            oauth_token_secret: options[:oauth_access_token_secret]
+          }
+        )
+      else
+        raise ArgumentError.new("You must specify either request token options [#{request_token_options.join(',')}] or [#{oauth_token_options.join(',')}]")
+      end
+    end
+
+    def token
+      return oauth_access_token.nil? ? nil : oauth_access_token.token
+    end
+
+    def secret
+      return oauth_access_token.nil? ? nil : oauth_access_token.secret
+    end
+
+    def execute_request(method, path, options = {})
+      path, headers, body = Util.build_path_headers_and_body(method, path,
+        headers: options[:headers],
+        body: options[:body],
+        etag: options[:etag])
+      response =  nil
+      if REQUEST_METHODS_TO_PUT_PARAMS_IN_URL.include?(method)
+        response = self.oauth_access_token.send(method, path, headers)
+      else
+        # permit the body through since it'll be in the 
+        response = self.oauth_access_token.send(method, path, body, headers)
+      end
+      MyJohnDeere.logger.info("JohnDeere token response: #{response.body}")
+      # if response.code == "401"
+      #   self.notify_on_destroy = true
+      #   # we are no longer authorized
+      #   self.destroy
+      #   logger.info("JohnDeere token destroyed: #{self.persisted?}, errors: #{self.errors.full_messages}")
+      # end
+      # return response
+      return Response.new(response)
+    end
+  end
+end