omcms-ruby-client 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 486c879393ce195be83ee8ada89010f426cafd4370cb507f61c8f9811648526b
-  data.tar.gz: 464298d9dcd752ca1a456518c2a0ba88c1b23f962a7c170c27cca584ea415791
+  metadata.gz: b46ca753a8a873163b0932806bb79e938fc68458c8437c562853115c9548395b
+  data.tar.gz: ac3525d85b4d9b6dea51f70d96b2228cf79dda3ff3fe530c939010d03079dba3
 SHA512:
-  metadata.gz: 82dc8d0d1db64df172f23275d82a4e30c51df260e233b53b02853ecad580e3a7df2b64f76a09cb554b34911f5d5a32d3af5fdbff8f2638703d6618233fd1f4f8
-  data.tar.gz: dd72cf8dc05bf78827a61dfbd91c9f96828a870e1d5fedb092a8cec2925b9528ceb46e00cc1422c79573b90c679f6dff9a5de0eb6e31c3cf36ec350028beb93a
+  metadata.gz: 730fb31217a78bfe393d8dd69d893e9a177ecd5899eeecf5910f0dcd4ff79837a6b2169c87826add1affcddecabdc2eaf2055c8fb2a1779810061291ca19da22
+  data.tar.gz: d37727a2f6dd96c26383013c74d2a17b045a0de7ea15afd98a37ecd1b67e0db717d1bea1661fc383f073d2a3e9296032ace1eeba7fade66be9fcda821968b9e2

data/.gitignore

@@ -7,6 +7,8 @@
 /spec/reports/
 /tmp/
 Gemfile.lock
+.rubocop.yml
+omcms-ruby-client-*.gem
 
 # rspec failure tracking
 .rspec_status

data/Gemfile

@@ -1,4 +1,12 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in omcms-ruby-client.gemspec
 gemspec
+
+group :development, :test do
+  gem "bundler", ">= 2.0"
+  gem "rake", ">= 10.0"
+  gem "rspec", ">= 3.0"
+end

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "omcms"

data/lib/omcms/client.rb

@@ -1,40 +1,36 @@
+# frozen_string_literal: true
+
 module OMCMS
   class Client
     attr_reader :client
 
     def initialize(opts)
       configure_credentials(opts)
-      configure_client
-    end
-
-    def faraday &block
-      @faraday = block if block
-      @faraday
+      @client = configure_client
     end
 
     def configure_client
-      @client ||= Faraday.new do |f|
-        f.request :basic_auth, @username, @password
+      @configure_client ||= Faraday.new do |f|
+        f.request :authorization, :basic, @username, @password
         f.options[:open_timeout] = @open_timeout
         f.options[:timeout] = @timeout
         f.request :omcms_set_header
         f.response :omcms_parse_response
-        f.response :json, :content_type => /\bjson$/
-        faraday.call(f) if faraday
-        f.adapter Faraday.default_adapter unless faraday
+        f.response :json, content_type: /\bjson$/
+        f.adapter :httpclient
       end
     end
 
     def offerings
-      OMCMS::Offering.new(@client, @response, @host)
+      OMCMS::Offering.new(@client, @host, @response)
     end
 
     private
 
     def configure_credentials(opts)
-      raise ArgumentError.new "Public Key is missing for the OMCMS client" if opts[:public_key].to_s.empty?
-      raise ArgumentError.new "Private Key is missing for the OMCMS client" if opts[:private_key].to_s.empty?
-      raise ArgumentError.new "Host is missing for the OMCMS client" if opts[:host].to_s.empty?
+      raise ArgumentError, "Public Key is missing for the OMCMS client" if opts[:public_key].to_s.empty?
+      raise ArgumentError, "Private Key is missing for the OMCMS client" if opts[:private_key].to_s.empty?
+      raise ArgumentError, "Host is missing for the OMCMS client" if opts[:host].to_s.empty?
 
       @username = opts[:public_key]
       @password = opts[:private_key]
@@ -43,4 +39,4 @@ module OMCMS
       @timeout = opts[:timeout] || 20
     end
   end
-end
+end

data/lib/omcms/middleware/parse_response.rb

@@ -1,18 +1,18 @@
+# frozen_string_literal: true
+
 module OMCMS
   class ParseResponse < Faraday::Middleware
-    def initialize app
-      super app
+    def initialize(app)
+      super(app)
       @app = app
     end
 
-    def on_complete response_env
-      if response_env.status >= 400
-        return OMCMS::Response::Error.new(response_env)
-      else
-        return response_env.body
-      end
-    rescue => error
-      return OMCMS::Response::Error.new(error)
+    def on_complete(response_env)
+      return OMCMS::Response::Error.new(response_env) if response_env.status >= 400
+
+      response_env.body
+    rescue StandardError => e
+      OMCMS::Response::Error.new(e)
     end
   end
 end

data/lib/omcms/middleware/set_header.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module OMCMS
   class SetHeader < Faraday::Middleware
     HEADERS = {
-      :"user-agent" => "omcms/ruby/client/#{VERSION}"
-    }
+      "user-agent": "omcms/ruby/client/#{VERSION}"
+    }.freeze
 
-    def initialize app
-      super app
+    def initialize(app)
+      super(app)
       @app = app
     end
 
-    def on_request request_env
+    def on_request(request_env)
       request_env[:request_headers].merge! HEADERS
     end
   end

data/lib/omcms/resource/component.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module OMCMS
   class Component < Resource
-    def initialize(client, response = {}, host)
+    def initialize(client, host, response = {})
       @offering_id = response["id"]
       super
     end
 
     def all
-      perform_run self, request_path()
+      perform_run self, request_path
     end
 
     def get(id)

data/lib/omcms/resource/offering.rb

@@ -1,11 +1,9 @@
+# frozen_string_literal: true
+
 module OMCMS
   class Offering < Resource
-    def initialize(client, response, host)
-      super
-    end
-
     def all
-      perform_run self, request_path()
+      perform_run self, request_path
     end
 
     def get(id)

data/lib/omcms/resource/offering_data.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module OMCMS
   class OfferingData < Resource
-    def initialize(client, response = {}, host)
+    def initialize(client, host, response = {})
       @offering_id = response["id"]
       super
     end
 
     def all
-      perform_run self, request_path()
+      perform_run self, request_path
     end
 
     def get(id)

data/lib/omcms/resource.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module OMCMS
   class Resource
-    def initialize(client, response = {}, host = nil)
+    def initialize(client, host = nil, _response = {})
       @client = client
       @host = host
     end
@@ -16,8 +18,9 @@ module OMCMS
       class_name = instance.class.name.split("::").last
       response = @client.get request_url
 
-      return response if response.class == OMCMS::Response::Error
-      response_class(class_name).new(@client, response, @host)
+      return response if response.instance_of?(OMCMS::Response::Error)
+
+      response_class(class_name).new(@client, @host, response)
     end
   end
 end

data/lib/omcms/response/body.rb

@@ -1,44 +1,45 @@
+# frozen_string_literal: true
+
 module OMCMS
   module Response
     class Body
       attr_reader :body
 
-      def initialize(client, response, host)
+      def initialize(client, host, response)
         @client = client
         @body = response.body
         @host = host
       end
 
-      def to_json
+      def to_json(*_args)
         parse(@body)
       end
 
       private
 
       def parse(data = "")
-        if data.class == Hash
-          return data.keys.map do |attribute|
+        if data.instance_of?(Hash)
+          return data.keys.to_h do |attribute|
             key = snakecase(attribute)
             [key, parse(data[attribute])]
-          end.to_h
-        elsif data.class == Array
+          end
+        elsif data.instance_of?(Array)
           return data.map do |object|
-            hash = object.keys.map do |attribute|
+            object.keys.to_h do |attribute|
               key = snakecase(attribute)
               [key, parse(object[attribute])]
-            end.to_h
+            end
           end
         end
-        return data
+        data
       end
 
-
       def snakecase(data = "")
-        data.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-            .gsub(/([a-z\d])([A-Z])/,'\1_\2')
-            .tr('-', '_')
-            .gsub(/\s/, '_')
-            .gsub(/__+/, '_')
+        data.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+            .tr("-", "_")
+            .gsub(/\s/, "_")
+            .gsub(/__+/, "_")
             .downcase
       end
     end

data/lib/omcms/response/component.rb

@@ -1,9 +1,8 @@
+# frozen_string_literal: true
+
 module OMCMS
   module Response
     class Component < Body
-      def initialize(client, data, host)
-        super
-      end
     end
   end
 end

data/lib/omcms/response/error.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module OMCMS
   module Response
     class Error < StandardError
       attr_reader :status
 
-      def initialize response
+      def initialize(response)
+        super
         return unless response
-        unless response.respond_to? :body
-          response = add_body_to_error(response)
-        end
+
+        response = add_body_to_error(response) unless response.respond_to? :body
 
         response.body.each do |key, value|
           instance_variable_set("@#{key}", value)
@@ -15,17 +17,17 @@ module OMCMS
         end
       end
 
-      def to_json
-        self.instance_variables.map do |attribute|
-          key = attribute.to_s.gsub('@','')
-          [snakecase(key), self.instance_variable_get(attribute)]
-        end.to_h
+      def to_json(*_args)
+        instance_variables.to_h do |attribute|
+          key = attribute.to_s.gsub("@", "")
+          [snakecase(key), instance_variable_get(attribute)]
+        end
       end
 
       private
 
       def add_body_to_error(response)
-        OpenStruct.new(
+        Struct.new(
           body: {
             name: response.class,
             message: response.message,
@@ -35,11 +37,11 @@ module OMCMS
       end
 
       def snakecase(data = "")
-        data.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-            .gsub(/([a-z\d])([A-Z])/,'\1_\2')
-            .tr('-', '_')
-            .gsub(/\s/, '_')
-            .gsub(/__+/, '_')
+        data.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+            .tr("-", "_")
+            .gsub(/\s/, "_")
+            .gsub(/__+/, "_")
             .downcase
       end
     end

data/lib/omcms/response/offering.rb

@@ -1,16 +1,14 @@
+# frozen_string_literal: true
+
 module OMCMS
   module Response
     class Offering < Body
-      def initialize(client, data, host)
-        super
-      end
-
       def components
-        OMCMS::Component.new(@client, self.body, @host)
+        OMCMS::Component.new(@client, @host, body)
       end
 
       def data
-        OMCMS::OfferingData.new(@client, self.body, @host)
+        OMCMS::OfferingData.new(@client, @host, body)
       end
     end
   end

data/lib/omcms/response/offering_data.rb

@@ -1,9 +1,8 @@
+# frozen_string_literal: true
+
 module OMCMS
   module Response
     class OfferingData < Body
-      def initialize(client, data, host)
-        super
-      end
     end
   end
 end

data/lib/omcms/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OMCMS
-  VERSION = "1.1.0"
+  VERSION = "1.3.0"
 end

data/lib/omcms.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require "faraday"
+require "faraday/httpclient"
 
 require "omcms/client"
 require "omcms/resource"

data/omcms-ruby-client.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "omcms/version"
@@ -6,10 +8,11 @@ Gem::Specification.new do |spec|
   spec.name          = "omcms-ruby-client"
   spec.version       = OMCMS::VERSION
   spec.authors       = ["Pradeep Rawat"]
-  spec.email         = ["pradeep@akaruilabs.com"]
+  spec.email         = ["pradeep.rawat@equitymultiple.com"]
 
-  spec.summary       = %q{A Ruby SDK for OMCMS APIs}
-  spec.description   = %q{omcms-ruby-client make is simpler to use OMCMS connector APIs and integrate with existing Ruby application}
+  spec.summary       = "A Ruby SDK for OMCMS APIs"
+  spec.description   = "omcms-ruby-client make is simpler to use OMCMS connector APIs
+                        and integrate with existing Ruby application"
   spec.homepage      = "https://github.com/equitymultiple/omcms-ruby-client"
 
   spec.metadata["homepage_uri"] = spec.homepage
@@ -17,16 +20,16 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
-  spec.add_dependency "faraday", "~> 1.0"
+  spec.add_dependency "faraday", ">= 2.0", "< 3"
+  spec.add_dependency "faraday-httpclient", "~> 2.0"
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,75 +1,54 @@
 --- !ruby/object:Gem::Specification
 name: omcms-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Pradeep Rawat
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-28 00:00:00.000000000 Z
+date: 2024-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-  type: :development
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: faraday-httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: '2.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: omcms-ruby-client make is simpler to use OMCMS connector APIs and integrate
-  with existing Ruby application
+        version: '2.0'
+description: |-
+  omcms-ruby-client make is simpler to use OMCMS connector APIs
+                          and integrate with existing Ruby application
 email:
-- pradeep@akaruilabs.com
+- pradeep.rawat@equitymultiple.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -102,6 +81,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/equitymultiple/omcms-ruby-client
   source_code_uri: https://github.com/equitymultiple/omcms-ruby-client
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -110,14 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: A Ruby SDK for OMCMS APIs