myjohndeere 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97de75462b83ea9c04fb0910eddf732c5affe625
-  data.tar.gz: 7484ca74f1e54531717ab252b15b411d9baaf69c
+  metadata.gz: 19143fdf01d2f2e3fc3eb61a056784ab48ad13b0
+  data.tar.gz: 993ce13479bad9f237f88583a70a8fa3b7110136
 SHA512:
-  metadata.gz: f3514ced5a8b3562afd29aa60f46ba4a446b31710ed74c29578761d67d1104ec2823f6df2a4b34efd69214b25761661843b40f7813543d5599ab7399c6c99339
-  data.tar.gz: 5fce3d3e6c94a6652fde1443e12921c160f84716bcd5870f42a2760af5bb672a272fb9cd3e4c4caa1126eea1a6bb11c56741fcb9960ef6ce60f388ad502f86a7
+  metadata.gz: 92af50934686b143601301a29b07ac15cc432751942516dec22a1345eb2202ff1f005d2ed4b4816d65c1e43232dddcbd353d23d8e47c6ae8024a4bc03f248938
+  data.tar.gz: 89a9a893e011627cf950349c88201e0e4c061876f278f495775cc29d33299e027139c2ca168855712122670c1b3e0b392fa64a653eb0079bd06f64f3c1c8016a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    myjohndeere (0.0.1)
+    myjohndeere (0.0.2)
       oauth (>= 0.5.3)
 
 GEM

data/lib/myjohndeere/access_token.rb

@@ -59,6 +59,7 @@ module MyJohnDeere
         body: options[:body],
         etag: options[:etag])
       response =  nil
+      MyJohnDeere.logger.debug("Sending request with body: #{body}\n headers: #{headers}")
       if REQUEST_METHODS_TO_PUT_PARAMS_IN_URL.include?(method)
         response = self.oauth_access_token.send(method, path, headers)
       else
@@ -66,13 +67,7 @@ module MyJohnDeere
         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
+      Util.handle_response_error_codes(response)
       return Response.new(response)
     end
   end

data/lib/myjohndeere/errors.rb

@@ -2,9 +2,60 @@ module MyJohnDeere
   # MyJohnDeereError is the base error from which all other more specific MyJohnError
   # errors derive.
   class MyJohnDeereError < StandardError
+    attr_reader :message
+
+    # These fields are now available as part of #response and that usage should
+    # be preferred.
+    attr_reader :http_body
+    attr_reader :http_headers
+    attr_reader :http_status
+
+    attr_accessor :response
+    # Initializes a MyJohnDeereError.
+    def initialize(message=nil, http_status: nil, http_body: nil,
+                   http_headers: nil, my_john_deere_response: nil)
+      @message = message
+      if my_john_deere_response.is_a?(MyJohnDeere::Response) then
+        self.response = my_john_deere_response
+        http_status = my_john_deere_response.http_status
+        http_body = my_john_deere_response.http_body
+        http_headers = my_john_deere_response.http_headers
+      end
+      @http_status = http_status
+      @http_body = http_body
+      @http_headers = http_headers || {}
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      id_string = @request_id.nil? ? "" : "(Request #{@request_id}) "
+      "#{status_string}#{id_string}#{@message}"
+    end
   end
 
   # Configuration error is raised when configuration hasn't been properly done
   class ConfigurationError < MyJohnDeereError
   end
+
+  # AuthenticationError is raised when invalid credentials are used to connect
+  # to MyJohnDeere's servers or if your credentials have expired.
+  class AuthenticationError < MyJohnDeereError
+  end
+
+  # Raised when accessing resources you don't have access to. Generally just need to
+  # avoid making this request
+  class PermissionError < MyJohnDeereError
+  end
+
+  # Raised when too many requests are being made
+  class RateLimitError < MyJohnDeereError
+  end
+
+  # Raised when something goes wrong with MyJohnDeere API
+  class InternalServerError < MyJohnDeereError
+  end
+
+  # Raised when the server is busy
+  class ServerBusyError < MyJohnDeereError
+  end
 end

data/lib/myjohndeere/file_resource.rb

@@ -30,17 +30,7 @@ module MyJohnDeere
         metadata: metadata.map { |m| m.to_hash }
       }
       
-      response = access_token.execute_request(:post, 
-        build_resouce_base_path!(self.list_resource_path, {map_layer_id: map_layer_id}),
-        body: body
-      )
-      #{"Content-Type"=>"text/plain", "X-Deere-Handling-Server"=>"ldxtc3", "X-Frame-Options"=>"SAMEORIGIN", "Location"=>"https://sandboxapi.deere.com/platform/mapLayers/e2711205-c5df-445e-aad5-81eaf9090e6c", "X-Deere-Elapsed-Ms"=>"162", "Vary"=>"Accept-Encoding", "Expires"=>"Thu, 14 Sep 2017 15:52:24 GMT", "Cache-Control"=>"max-age=0, no-cache", "Pragma"=>"no-cache", "Date"=>"Thu, 14 Sep 2017 15:52:24 GMT", "Transfer-Encoding"=>"chunked", "Connection"=>"close, Transfer-Encoding"}
-      id = get_created_id_from_response_headers(self.base_jd_resource, response)
-      if id.nil? then
-        return nil
-      else
-        return self.new(HashUtils.deep_stringify_keys({"id" => id}.merge(body)))
-      end
+      return send_create(access_token, body, {map_layer_id: map_layer_id})
     end
 
     def self.upload_file(access_token, file_resource_id, file_path)

data/lib/myjohndeere/map_layer.rb

@@ -30,12 +30,7 @@ module MyJohnDeere
         }
       }
 
-      response = access_token.execute_request(:post, 
-        build_resouce_base_path!(self.list_resource_path, {map_layer_summary_id: map_layer_summary_id}),
-        body: body
-      )
-      #{"Content-Type"=>"text/plain", "X-Deere-Handling-Server"=>"ldxtc3", "X-Frame-Options"=>"SAMEORIGIN", "Location"=>"https://sandboxapi.deere.com/platform/mapLayers/e2711205-c5df-445e-aad5-81eaf9090e6c", "X-Deere-Elapsed-Ms"=>"162", "Vary"=>"Accept-Encoding", "Expires"=>"Thu, 14 Sep 2017 15:52:24 GMT", "Cache-Control"=>"max-age=0, no-cache", "Pragma"=>"no-cache", "Date"=>"Thu, 14 Sep 2017 15:52:24 GMT", "Transfer-Encoding"=>"chunked", "Connection"=>"close, Transfer-Encoding"}
-      return get_created_id_from_response_headers(self.base_jd_resource, response)
+      return send_create(access_token, body, {map_layer_summary_id: map_layer_summary_id})
     end
   end
 end

data/lib/myjohndeere/map_layer_summary.rb

@@ -24,17 +24,8 @@ module MyJohnDeere
         metadata: metadata.map { |md| md.to_hash },
         dateCreated: (date_created || Time.now).strftime("%Y-%m-%dT%H:%M:%S.%LZ")
       }
-      response = access_token.execute_request(:post, 
-        build_resouce_base_path!(self.list_resource_path, {field_id: field_id, organization_id: organization_id}),
-        body: body
-      )
-      #{"Content-Type"=>"text/plain", "X-Deere-Handling-Server"=>"ldxtc4", "X-Frame-Options"=>"SAMEORIGIN", "Location"=>"https://sandboxapi.deere.com/platform/mapLayerSummaries/c5e9317e-eda6-48d3-acc8-c3bca3424858", "X-Deere-Elapsed-Ms"=>"362", "Vary"=>"Accept-Encoding", "Expires"=>"Wed, 13 Sep 2017 22:00:45 GMT", "Cache-Control"=>"max-age=0, no-cache", "Pragma"=>"no-cache", "Date"=>"Wed, 13 Sep 2017 22:00:45 GMT", "Transfer-Encoding"=>"chunked", "Connection"=>"close, Transfer-Encoding"}
-      id = get_created_id_from_response_headers(self.base_jd_resource, response)
-      if id.nil?
-        return nil
-      else
-        return self.new(HashUtils.deep_stringify_keys({"id" => id}.merge(body)))
-      end
+      
+      return send_create(access_token, body, {field_id: field_id, organization_id: organization_id})
     end
   end
 end

data/lib/myjohndeere/rest_methods.rb

@@ -15,7 +15,7 @@ module MyJohnDeere
           options[:body][sbp] = options[sbp]
         end
 
-        response = access_token.execute_request(:get, build_resouce_base_path!(self.list_resource_path, options), 
+        response = access_token.execute_request(:get, build_resource_base_path!(self.list_resource_path, options), 
           options
         )
         return ListObject.new(
@@ -31,25 +31,44 @@ module MyJohnDeere
       def retrieve(access_token, id, options={})
         validate_access_token(access_token)
         response = access_token.execute_request(:get, 
-          "#{build_resouce_base_path!(self.retrieve_resource_path, options)}/#{id}",
+          "#{build_resource_base_path!(self.retrieve_resource_path, options)}/#{id}",
           options)
 
         return new(response.data, access_token)
       end
 
-      def build_resouce_base_path!(resource_path, options)
+      def build_resource_base_path!(resource_path, options = {})
+        expected_definitions = resource_path.scan(/%{(.+?)}/)
+        return resource_path if expected_definitions.empty?
         base_resources = {}
         options.each do |key, val|
           base_resources[key] = options.delete(key) if key.match(/_id\Z/)
         end
-        return resource_path if base_resources.nil? || base_resources.empty?
         MyJohnDeere.logger.info("Building resource path: #{resource_path}, with ids: #{base_resources}")
-        return resource_path % base_resources
+        begin 
+          return resource_path % base_resources
+        rescue KeyError
+          raise ArgumentError.new("You must specify #{expected_definitions.join(", ")} as part of this request path")
+        end
       end
 
       def validate_access_token(access_token)
         raise ArgumentError.new("The first argument must be an #{AccessToken}") if !access_token.is_a?(AccessToken)
       end
+
+      def send_create(access_token, body, path_builder_options = {})
+        response = access_token.execute_request(:post, 
+          build_resource_base_path!(self.list_resource_path, path_builder_options),
+          body: body
+        )
+        #{"Content-Type"=>"text/plain", "X-Deere-Handling-Server"=>"ldxtc3", "X-Frame-Options"=>"SAMEORIGIN", "Location"=>"https://sandboxapi.deere.com/platform/mapLayers/e2711205-c5df-445e-aad5-81eaf9090e6c", "X-Deere-Elapsed-Ms"=>"162", "Vary"=>"Accept-Encoding", "Expires"=>"Thu, 14 Sep 2017 15:52:24 GMT", "Cache-Control"=>"max-age=0, no-cache", "Pragma"=>"no-cache", "Date"=>"Thu, 14 Sep 2017 15:52:24 GMT", "Transfer-Encoding"=>"chunked", "Connection"=>"close, Transfer-Encoding"}
+        id = get_created_id_from_response_headers(self.base_jd_resource, response)
+        if id.nil? then
+          return nil
+        else
+          return self.new(HashUtils.deep_stringify_keys({"id" => id}.merge(body)))
+        end
+      end
     end
      
     module InstanceMethods

data/lib/myjohndeere/util.rb

@@ -50,5 +50,36 @@ module MyJohnDeere
 
       return path, headers, body
     end
+
+    def self.handle_response_error_codes(response)
+      headers = response.to_hash
+      code = response.code.to_i
+      body = response.body
+      error = nil
+      case code
+      when 503
+        error = ServerBusyError
+      when 400, 404
+        error = InvalidRequestError
+      when 401
+        error = AuthenticationError
+      when 403
+        error = PermissionError
+      when 429
+        error = RateLimitError
+      when 500
+        error = InternalServerError
+      end
+        
+      if error.nil? then
+        return
+      else
+        error = error.new(
+          http_status: code, http_body: body,
+          http_headers: headers)
+        error.response = response
+        raise error
+      end
+    end
   end
 end

data/lib/myjohndeere/version.rb

@@ -1,3 +1,3 @@
 module MyJohnDeere
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/myjohndeere.gemspec

@@ -7,7 +7,7 @@ spec = Gem::Specification.new do |s|
   s.version = MyJohnDeere::VERSION
   s.required_ruby_version = '>= 1.9.3'
   s.summary = 'Ruby bindings for the MyJohnDeere API'
-  s.description = ' MyJohnDeere is used to make data-driven decisions to maximize your return on every acre. This Ruby Gem is provided as a convenient way to access their API.'
+  s.description = ' MyJohnDeere allows you to access your John Deere Financial account, JDLink, Operations Center and many other applications from one convenient place. This Ruby Gem is provided as a convenient way to access their API.'
   s.author = 'Paul Susmarski'
   s.email = 'paul@susmarski.com'
   s.homepage = 'https://github.com/psusmars/myjohndeere'

data/test/test_access_token.rb

@@ -47,6 +47,16 @@ class TestAccessToken < Minitest::Test
     assert_equal expected_secret, at.secret
   end
 
+  def test_send_request_with_bad_responses
+    at = default_access_token()
+    stub_request(:get, "https://sandboxapi.deere.com/platform/").
+      to_return(status: 403, body: "Stuff")
+
+    assert_raises MyJohnDeere::PermissionError do
+      at.execute_request(:get, "/")
+    end
+  end
+
   def test_send_get_request
     at = default_access_token()
     expected_json = API_FIXTURES.fetch("api_catalog")

data/test/test_map_layer.rb

@@ -48,6 +48,7 @@ class TestMapLayer < Minitest::Test
       title: "blah",
       map_layer_id: "foo", map_legend_items: [MyJohnDeere::MapLegendItem.new("bar", 1, 2, "#0BA74A", 15.0)]
     )
-    assert_equal MAP_LAYER_ID, response
+    assert_equal MAP_LAYER_ID, response.id
+    assert_equal ORGANIZATION_ID, response.organization_id
   end
 end

data/test/test_rest_methods.rb

@@ -24,6 +24,19 @@ class TestRestMethods < Minitest::Test
     assert_equal "something", organizations.etag
   end
 
+  def test_build_resource_base_path
+    resource_path = "blah"
+    assert_equal "blah", MyJohnDeere::Organization.build_resource_base_path!("blah", {})
+    resource_path = "blah%{x_id}"
+    options = {x: 5, x_id: 1}
+    assert_equal "blah1", MyJohnDeere::Organization.build_resource_base_path!(resource_path, options)
+    assert_equal({x: 5}, options)
+
+    assert_raises ArgumentError do
+      MyJohnDeere::Organization.build_resource_base_path!(resource_path, {})
+    end
+  end
+
   def test_list_with_body
     stub_request(:get, /organizations;start=0;count=1/).
       with(query: {embed: "boundaries"}).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: myjohndeere
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Paul Susmarski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-14 00:00:00.000000000 Z
+date: 2017-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -24,9 +24,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.5.3
-description: ' MyJohnDeere is used to make data-driven decisions to maximize your
-  return on every acre. This Ruby Gem is provided as a convenient way to access their
-  API.'
+description: ' MyJohnDeere allows you to access your John Deere Financial account,
+  JDLink, Operations Center and many other applications from one convenient place.
+  This Ruby Gem is provided as a convenient way to access their API.'
 email: paul@susmarski.com
 executables: []
 extensions: []