smartcar 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f96ead76c474cc7bd2f579c79ae5457437b7826ea5738fc939e78e7fd15ad9a
-  data.tar.gz: 4ca101d8945328f524a4c4fe525eef8c0fa9ed5828a6d7fc1e7d96bccc299015
+  metadata.gz: 40fb835517be1ed88352e2988be1800570c3bc6a2cd46db81d20cd1430aa5391
+  data.tar.gz: 23137d3489c55affd34287acc0a7301c6af04cf74ab7ec2bca0bc9476a11ee0b
 SHA512:
-  metadata.gz: c944b360628c97f3e78e6d1f7287e91c136a33cd8c696c0e8246c18839f97d790aea5457dc402ace57eda565f4937dbc72a51e5c66e70b12d24a1850674f6bcf
-  data.tar.gz: 73646b1545692c60714bd7581abef94f6271907587dc1ed2564dbae30adafb63b3c3d546b46f2188933fd2f4035a1eb8922fa4ef0c7e09a4fbd48a5d69c1cb11
+  metadata.gz: 46cdf2c55fb8213943e0e5841b91aafa4e9be4d9b24d7e6121507f341fe51871892074667774f2214329f61d299899e0b18505f9fc0d6d007f229861ae5a69de
+  data.tar.gz: bb650cc504f122c4adf1869f067316cb7470746fa19c33c7a81ad83c4371c9b417699d93e46ac2e35cd39a6bbcafb10f4f06cadaf06d667152c9118fff226153

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    smartcar (3.0.0)
+    smartcar (3.0.1)
       oauth2 (~> 1.4)
+      recursive-open-struct (~> 1.1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     backport (1.1.2)
@@ -53,6 +54,7 @@ GEM
     readapt (1.3.0)
       backport (~> 1.1)
       thor (~> 1.0)
+    recursive-open-struct (1.1.3)
     redcarpet (3.5.1)
     regexp_parser (2.1.1)
     rexml (3.2.5)

data/README.md

@@ -82,7 +82,7 @@ Example Usage for calling the reports API with oAuth token
 ```ruby
 2.5.7 :001 > require 'smartcar'
  => true
-2.5.7 :003 > ids =  Smartcar::Vehicle.get_vehicles(token: token).vehicles
+2.5.7 :003 > ids =  Smartcar.get_vehicles(token: token).vehicles
  => ["4bb777b2-bde7-4305-8952-25956f8c0868"]
 2.5.7 :004 > vehicle = Smartcar::Vehicle.new(token: token, id: ids.first)
  => #<Smartcar::Vehicle:0x0000558dcd7ee608 @token="c900e00e-ee8e-403d-a7bf-f992bc0ad302", @id="e31c9de6-1332-472b-b648-5d74b05b7fda", @options={:unit_system=>"metric", :version=>"2.0"}, @unit_system="metric", @version="2.0", @service=#<Faraday::Connection:0x0000558dcd7d63f0 @parallel_manager=nil, @headers={"User-Agent"=>"Faraday v1.4.2"}, @params={}, @options=#<Faraday::RequestOptions timeout=310>, @ssl=#<Faraday::SSLOptions verify=true>, @default_parallel_manager=nil, @builder=#<Faraday::RackBuilder:0x0000558dcd7c1bf8 @adapter=Faraday::Adapter::NetHttp, @handlers=[Faraday::Request::UrlEncoded], @app=#<Faraday::Request::UrlEncoded:0x0000558dcd7af048 @app=#<Faraday::Adapter::NetHttp:0x0000558dcd7af390 @ssl_cert_store=#<OpenSSL::X509::Store:0x0000558dcd7a36a8 @verify_callback=nil, @error=nil, @error_string=nil, @chain=nil, @time=nil>, @app=#<Proc:0x0000558dcd7af278 /home/ashwinsubramanian/.rvm/gems/ruby-2.7.2/gems/faraday-1.4.2/lib/faraday/adapter.rb:37 (lambda)>, @connection_options={}, @config_block=nil>, @options={}>>, @url_prefix=#<URI::HTTPS https://api.smartcar.com/>, @proxy=nil, @manual_proxy=false>>
@@ -165,4 +165,4 @@ To contribute, please:
 
 Smartcar aims to support the SDK on all Ruby branches that have a status of "normal maintenance" or "security maintenance" as defined in the [Ruby Branches documentation](https://www.ruby-lang.org/en/downloads/branches/).
 
-In accordance with the Semantic Versioning specification, the addition of support for new Ruby branches would result in a MINOR version bump and the removal of support for Ruby branches would result in a MAJOR version bump.
+In accordance with the Semantic Versioning specification, the addition of support for new Ruby branches would result in a MINOR version bump and the removal of support for Ruby branches would result in a MAJOR version bump.

data/lib/smartcar.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'recursive_open_struct'
 require 'smartcar_error'
 require 'smartcar/utils'
 require 'smartcar/version'

data/lib/smartcar/auth_client.rb

@@ -72,7 +72,7 @@ module Smartcar
                          .get_token(code, redirect_uri: redirect_uri)
                          .to_hash
 
-      JSON.parse(token_hash.to_json, object_class: OpenStruct)
+      json_to_ostruct(token_hash)
     rescue OAuth2::Error => e
       raise build_error(e.response.status, e.response.body, e.response.headers)
     end
@@ -89,7 +89,7 @@ module Smartcar
       token_object = OAuth2::AccessToken.from_hash(client, { refresh_token: token })
       token_object = token_object.refresh!
 
-      JSON.parse(token_object.to_hash.to_json, object_class: OpenStruct)
+      json_to_ostruct(token_object.to_hash)
     rescue OAuth2::Error => e
       raise build_error(e.response.status, e.response.body, e.response.headers)
     end

data/lib/smartcar/utils.rb

@@ -25,6 +25,18 @@ module Smartcar
       ENV[config_name]
     end
 
+    # Converts a hash to RecursiveOpenStruct (a powered up OpenStruct object).
+    # NOTE - Do not replace with the more elegant looking
+    # JSON.parse(meta_hash.to_json, object_class: OpenStruct)
+    # this is because we had an app using OJ as their json parser which led to an issue using the
+    # above mentioned method. Source : https://github.com/ohler55/oj/issues/239
+    # @param hash [Hash] json object as hash
+    #
+    # @return [RecursiveOpenStruct]
+    def json_to_ostruct(hash)
+      RecursiveOpenStruct.new(hash)
+    end
+
     def build_meta(headers)
       meta_hash = {
         'sc-data-age' => :data_age,
@@ -33,14 +45,14 @@ module Smartcar
       }.each_with_object({}) do |(header_name, key), meta|
         meta[key] = headers[header_name] if headers[header_name]
       end
-      meta = JSON.parse(meta_hash.to_json, object_class: OpenStruct)
+      meta = json_to_ostruct(meta_hash)
       meta.data_age &&= DateTime.parse(meta.data_age)
 
       meta
     end
 
     def build_response(body, headers)
-      response = JSON.parse(body.to_json, object_class: OpenStruct)
+      response = json_to_ostruct(body)
       response.meta = build_meta(headers)
       response
     end

data/lib/smartcar/version.rb

@@ -2,5 +2,5 @@
 
 module Smartcar
   # Gem current version number
-  VERSION = '3.0.0'
+  VERSION = '3.0.1'
 end

data/ruby-sdk.gemspec

@@ -36,4 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'selenium-webdriver', '~> 3.142'
   spec.add_development_dependency 'webmock', '~> 3.13'
   spec.add_dependency 'oauth2', '~> 1.4'
+  spec.add_dependency 'recursive-open-struct', '~> 1.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartcar
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Ashwin Subramanian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,6 +170,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.3
 description: This is a ruby gem to access the smartcar APIs. It includes the API classes
   and the OAuth system.
 email:
@@ -191,7 +205,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/open_struct_extensions.rb
 - lib/smartcar.rb
 - lib/smartcar/auth_client.rb
 - lib/smartcar/base.rb

data/lib/open_struct_extensions.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-# Extension to OpenStruct to convert a nested OpenStruct object to a hash.
-# Using this method any of the API response can be converted back to hash
-# or JSON (from hash) for convenience.
-# Example Usage :
-# response = {a: { b: {c: "test", d: [{x: 1}, {y: 3}]}}}
-class OpenStruct
-  def deep_to_h
-    to_h.transform_values do |value|
-      case value
-      when is_a?(OpenStruct)
-        value.deep_to_h
-      when is_a?(Array)
-        value.map { |item| item.is_a?(OpenStruct) ? item.deep_to_h : item }
-      else
-        value
-      end
-    end
-  end
-end