omcms-ruby-client 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f65d5c22539416150d654ead0405f04ef72226d75460379e5ddd1e77a39934da
-  data.tar.gz: 57cf48d1429d89c189fa61e46a943e1cf1a7b3e1cd326d663002dcf01dbd9a73
+  metadata.gz: ab39e0ec91ceb944add5ef432e128f57cf100ff63e465a7753d7016c4e3aefdf
+  data.tar.gz: 542fc89c8d2ef2e3a29938aa4b4f107f7c22a2c45c49d07df501a6a40e871733
 SHA512:
-  metadata.gz: 6abc2cb278b925dac14f027b102c7c73a653a4ba04816015e757f601f6ec68d400c3371f7057665f3977c49db965ed6e372da7d4bd5bef7bdf647a3ff73da6ff
-  data.tar.gz: e4c497b8f12a0b42ed5c701d72da2f8283c471e40024e183a66e6c0db8c5cdc939e0d1b5e1b51185c2aecaf14ebbaf208fef17c98598c87f6e223b7b60a56845
+  metadata.gz: c306e712943c1287f268e0f770cf11b38b26631c960185d05f3ff9503abe294d1a6409b515bfc526235af3e2249427e3203d8c3469d1d7e0cd2bb12ea4cfb5cf
+  data.tar.gz: e171d02809aaa2baf2c579dddcc9bae8c0ba5bce249994496edd6ab6f3c5bd6666016bd823a91b07acdabe0c0df75b2a9349fee50a4d9493ca162115e3743cd1

data/.github/pull_request_template.md

@@ -0,0 +1,10 @@
+<!--- Summarize your changes here -->
+
+## JIRA Issue
+
+[<change_me>](https://equitymultiple.atlassian.net/browse/<change_me>)
+
+## Rationale
+<!--- describe how your changes solve the linked issue -->
+<!--- if any alternatives were considered, explain the -->
+<!--- tradeoffs, and how this solution was ultimately chosen -->

data/.github/workflows/semantic-pr.yaml

@@ -0,0 +1,18 @@
+name: 'Semantic PR'
+
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      # Please look up the latest version at
+      # https://github.com/amannn/action-semantic-pull-request/releases
+      - uses: amannn/action-semantic-pull-request@v5.5.3
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/semantic-release.yaml

@@ -0,0 +1,31 @@
+name: Semantic Release
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '.github/**'
+      - 'README.md'
+
+jobs:
+  semantic-release:
+    name: Semantic Release
+    runs-on: ubuntu-latest
+    concurrency: semantic-release
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4.1.7
+        with:
+          persist-credentials: false
+
+      - name: Semantic Release
+        id: semantic
+        uses: cycjimmy/semantic-release-action@v4.1.0
+        with:
+          semantic_version: 19.0.5
+          extra_plugins: |
+            conventional-changelog-conventionalcommits@5.0.0
+            @semantic-release/exec@6.0.3
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.releaserc.yaml

@@ -0,0 +1,26 @@
+---
+# The branches on which releases should happen
+branches:
+  - main
+plugins:
+# commit-analyzer determines the type of release by analyzing commits with conventional-changelog
+# we use the default angular commit message conventions
+# https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit
+- "@semantic-release/commit-analyzer"
+
+# Generate release notes for the commits added since the last release with conventional-changelog
+- "@semantic-release/release-notes-generator"
+
+# Update the CHANGELOG.md file
+- - "@semantic-release/changelog"
+  - changelogFile: CHANGELOG.md
+
+# Publishes a GitHub "release" and comments on released Pull Requests/Issues.
+- - "@semantic-release/github"
+  - assets:
+    - CHANGELOG.md
+
+# Commits release assets (changelog) to the repo
+- - "@semantic-release/git"
+  - assets:
+    - CHANGELOG.md

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in omcms-ruby-client.gemspec

data/README.md

@@ -35,6 +35,7 @@ $omcms = OMCMS::Client.new(
   private_key: ENV["OMCMS_PRIVATE_KEY"],
   open_timeout: ENV["OMCMS_OPEN_TIMEOUT"], # optional default to 10 seconds
   timeout: ENV["OMCMS_TIMEOUT"] # optional default to 20 seconds
+  adapter: :httpclient # optional HTTP adapter and defaults to `Faraday.default_adapter`
 )
 ```
 

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,46 +1,43 @@
+# 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|
+      @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 @adapter
       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]
       @host = opts[:host]
       @open_timeout = opts[:open_timeout] || 10
       @timeout = opts[:timeout] || 20
+      @adapter = opts[:adapter] || Faraday.default_adapter
     end
   end
 end

data/lib/omcms/middleware/parse_response.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module OMCMS
   class ParseResponse < Faraday::Middleware
     def initialize(app)
-      super app
+      super
       @app = app
     end
 

data/lib/omcms/middleware/set_header.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OMCMS
   class SetHeader < Faraday::Middleware
     HEADERS = {
@@ -5,7 +7,7 @@ module OMCMS
     }.freeze
 
     def initialize(app)
-      super app
+      super
       @app = app
     end
 

data/lib/omcms/resource/component.rb

@@ -1,6 +1,8 @@
+# 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

data/lib/omcms/resource/offering.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OMCMS
   class Offering < Resource
     def all

data/lib/omcms/resource/offering_data.rb

@@ -1,6 +1,8 @@
+# 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

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
@@ -18,7 +20,7 @@ module OMCMS
 
       return response if response.instance_of?(OMCMS::Response::Error)
 
-      response_class(class_name).new(@client, response, @host)
+      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.2.0"
+  VERSION = "1.4.0"
 end

data/lib/omcms.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "faraday"
 
 require "omcms/client"

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"
@@ -9,11 +11,10 @@ Gem::Specification.new do |spec|
   spec.email         = ["pradeep.rawat@equitymultiple.com"]
 
   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.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
-  spec.metadata["source_code_uri"] = "https://github.com/equitymultiple/omcms-ruby-client"
+  spec.license       = nil
 
   # 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.
@@ -23,8 +24,9 @@ Gem::Specification.new do |spec|
   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(">= 3.2.0")
 
-  spec.add_dependency "faraday", ">= 1.0"
+  spec.add_dependency "faraday", ">= 2.0", "< 3"
 
   spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omcms-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Pradeep Rawat
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-26 00:00:00.000000000 Z
+date: 2024-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,23 +16,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-description: omcms-ruby-client make is simpler to use OMCMS connector APIs and integrate
-  with existing Ruby application
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: |-
+  omcms-ruby-client make is simpler to use OMCMS connector APIs
+                          and integrate with existing Ruby application
 email:
 - pradeep.rawat@equitymultiple.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/pull_request_template.md"
+- ".github/workflows/semantic-pr.yaml"
+- ".github/workflows/semantic-release.yaml"
 - ".gitignore"
+- ".releaserc.yaml"
 - ".rspec"
 - ".travis.yml"
 - Gemfile
@@ -56,10 +67,9 @@ files:
 - lib/omcms/version.rb
 - omcms-ruby-client.gemspec
 homepage: https://github.com/equitymultiple/omcms-ruby-client
-licenses: []
+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: []
@@ -69,14 +79,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.19
 signing_key:
 specification_version: 4
 summary: A Ruby SDK for OMCMS APIs