beyond_api 0.17.0.pre → 0.20.0.pre

data/lib/beyond_api/resources/webhook_subscriptions.rb

@@ -3,7 +3,7 @@
 require "beyond_api/utils"
 
 module BeyondApi
-  class WebhookSubscriptions < Base # :category: Resources
+  class WebhookSubscriptions < Base
     include BeyondApi::Utils
 
     #
@@ -22,7 +22,10 @@ module BeyondApi
     #   session.webhook_subscriptions.activate("268a8629-55cd-4890-9013-936b9b5ea14c")
     #
     def activate(webhook_subscription_id)
-      response, status = BeyondApi::Request.post(@session, "/webhook-subscriptions/#{webhook_subscription_id}/activate")
+      path = "/webhook-subscriptions/#{webhook_subscription_id}/activate"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path)
 
       handle_response(response, status, respond_with_true: true)
     end
@@ -44,7 +47,9 @@ module BeyondApi
     #   @webhook_subscriptions = session.webhook_subscriptions.all(size: 100, page: 0)
     #
     def all(params = {})
-      handle_all_request("/webhook-subscriptions", :webhook_subscriptions, params)
+      path = "/webhook-subscriptions"
+
+      handle_all_request(path, :webhook_subscriptions, params)
     end
 
     #
@@ -74,7 +79,11 @@ module BeyondApi
     #   @webhook_subscription = session.webhook_subscriptions.create(body)
     #
     def create(body)
-      response, status = BeyondApi::Request.post(@session, "/webhook-subscriptions", body)
+      path = "/webhook-subscriptions"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path,
+                                                 body)
 
       handle_response(response, status)
     end
@@ -93,7 +102,10 @@ module BeyondApi
     #   session.webhook_subscriptions.deactivate("a597cea4-b688-4164-8c56-b6568ea4d5aa")
     #
     def deactivate(webhook_subscription_id)
-      response, status = BeyondApi::Request.post(@session, "/webhook-subscriptions/#{webhook_subscription_id}/deactivate")
+      path = "/webhook-subscriptions/#{webhook_subscription_id}/deactivate"
+
+      response, status = BeyondApi::Request.post(@session,
+                                                 path)
 
       handle_response(response, status, respond_with_true: true)
     end
@@ -112,7 +124,10 @@ module BeyondApi
     #   session.webhook_subscriptions.delete("c6076a5a-a8ad-443f-b20b-8a1b268b069e")
     #
     def delete(webhook_subscription_id)
-      response, status = BeyondApi::Request.delete(@session, "/webhook-subscriptions/#{webhook_subscription_id}")
+      path = "/webhook-subscriptions/#{webhook_subscription_id}"
+
+      response, status = BeyondApi::Request.delete(@session,
+                                                   path)
 
       handle_response(response, status, respond_with_true: true)
     end
@@ -132,7 +147,10 @@ module BeyondApi
     #   @webhook_subscription = session.webhook_subscriptions.find("3d44ec71-768c-4927-9069-a96a5153e87c")
     #
     def find(webhook_subscription_id)
-      response, status = BeyondApi::Request.get(@session, "/webhook-subscriptions/#{webhook_subscription_id}")
+      path = "/webhook-subscriptions/#{webhook_subscription_id}"
+
+      response, status = BeyondApi::Request.get(@session,
+                                                path)
 
       handle_response(response, status)
     end
@@ -167,7 +185,11 @@ module BeyondApi
     #   @webhook_subscription = session.webhook_subscriptions.update("6f3bc033-c2d1-4f44-80e3-1b668f6bd699", body)
     #
     def update(webhook_subscription_id, body)
-      response, status = BeyondApi::Request.put(@session, "/webhook-subscriptions/#{webhook_subscription_id}", body)
+      path = "/webhook-subscriptions/#{webhook_subscription_id}"
+
+      response, status = BeyondApi::Request.put(@session,
+                                                path,
+                                                body)
 
       handle_response(response, status)
     end

data/lib/beyond_api/session.rb

@@ -26,11 +26,17 @@ module BeyondApi
   autoload :WebhookSubscriptions,        "beyond_api/resources/webhook_subscriptions"
 
   class Session
+    class InvalidUriProtocolError < StandardError; end
+
     attr_reader :api_url
     attr_accessor :access_token, :refresh_token
 
     def initialize(api_url:, access_token: nil, refresh_token: nil)
-      @api_url = api_url
+      raise InvalidUriProtocolError, "Invalid URI protocol" unless api_url.start_with? "https://"
+
+      uri = URI.parse(api_url)
+
+      @api_url = "#{uri.scheme}://#{uri.host}/api"
       @access_token = access_token
       @refresh_token = refresh_token
     end

data/lib/beyond_api/utils.rb

@@ -4,13 +4,34 @@ module BeyondApi
   module Utils
     extend self
 
-    def handle_response(response, status, respond_with_true: false)
-      if status.between?(200, 299)
-        return true if respond_with_true
-        response = sanitize_response(response)
-        BeyondApi.configuration.object_struct_responses ? to_object_struct(response) : response
+    def file_content_type(file_path)
+      case File.extname(file_path)
+      when ".png"
+        "image/png"
+      when ".jpg", ".jpeg"
+        "image/jpeg"
+      when ".gif"
+        "image/gif"
+      end
+    end
+
+    def handle_all_request(url, resource, params = {})
+      paginated_size = BeyondApi.configuration.all_pagination_size
+
+      if params[:paginated] == false
+        result = all_paginated(url, params.merge(page: 0, size: paginated_size))
+
+        (1..result[:page][:total_pages] - 1).each do |page|
+          result[:embedded][resource].concat(all_paginated(url, params.merge(page: page, size: paginated_size))[:embedded][resource])
+        end
+
+        result[:page][:size] = result[:page][:total_elements]
+        result[:page][:total_pages] = 1
+        result[:page][:number] = 0
+
+        result
       else
-        handle_error(response, status)
+        all_paginated(url, params)
       end
     end
 
@@ -20,64 +41,56 @@ module BeyondApi
       BeyondApi.configuration.raise_error_requests ? raise(error) : error
     end
 
-    def to_object_struct(data)
-      if data.is_a? Hash
-        return OpenStruct.new(data.map { |key, val| [key, to_object_struct(val)] }.to_h)
-      elsif data.is_a? Array
-        return data.map { |o| to_object_struct(o) }
+    def handle_response(response, status, respond_with_true: false)
+      if status.between?(200, 299)
+        return true if respond_with_true
+
+        response = sanitize_response(response)
+        BeyondApi.configuration.object_struct_responses ? to_object_struct(response) : response
       else
-        return data
+        handle_error(response, status)
       end
     end
 
+    def sanitize_key(key)
+      key.chars.first == "_" ? key[1..-1] : key
+    end
+
     def sanitize_response(hash)
       {}.tap do |h|
         hash.each do |key, value|
           next if key == "_links" && BeyondApi.configuration.remove_response_links
+
           key = sanitize_key(key) if BeyondApi.configuration.remove_response_key_underscores
           h[key.underscore.to_sym] = transform(value)
         end
       end
     end
 
-    def sanitize_key(key)
-      key.chars.first == "_" ? key[1..-1] : key
-    end
-
-    def handle_all_request(url, resource, params = {})
-      paginated_size = BeyondApi.configuration.all_pagination_size
-
-      if params[:paginated] == false
-        result = all_paginated(url, params.merge(page: 0, size: paginated_size))
-
-        (1..result[:page][:total_pages] - 1).each do |page|
-          result[:embedded][resource].concat(all_paginated(url, params.merge(page: page, size: paginated_size))[:embedded][resource])
-        end
-
-        result[:page][:size] = result[:page][:total_elements]
-        result[:page][:total_pages] = 1
-        result[:page][:number] = 0
-
-        result
+    def to_object_struct(data)
+      if data.is_a? Hash
+        OpenStruct.new(data.map { |key, val| [key, to_object_struct(val)] }.to_h)
+      elsif data.is_a? Array
+        data.map { |o| to_object_struct(o) }
       else
-        all_paginated(url, params)
+        data
       end
     end
 
     private
 
-      def transform(thing)
-        case thing
-        when Hash; sanitize_response(thing)
-        when Array; thing.map { |v| transform(v) }
-        else; thing
-        end
-      end
+    def all_paginated(url, params = {})
+      response, status = BeyondApi::Request.get(@session, url, params)
 
-      def all_paginated(url, params = {})
-        response, status = BeyondApi::Request.get(@session, url, params)
+      handle_response(response, status)
+    end
 
-        handle_response(response, status)
+    def transform(thing)
+      case thing
+      when Hash then sanitize_response(thing)
+      when Array then thing.map { |v| transform(v) }
+      else; thing
       end
+    end
   end
 end

data/lib/beyond_api/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BeyondApi
-  VERSION = "0.17.0.pre".freeze
+  VERSION = "0.20.0.pre"
 end

data/lib/beyond_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "beyond_api/version"
 
 require "logger"
@@ -25,7 +27,7 @@ module BeyondApi
   end
 
   class Configuration
-    attr_accessor :client_id, :client_secret, :open_timeout, :timeout,  :remove_response_links,
+    attr_accessor :client_id, :client_secret, :open_timeout, :timeout, :remove_response_links,
                   :remove_response_key_underscores, :object_struct_responses, :raise_error_requests,
                   :log_headers, :log_bodies, :log_level, :all_pagination_size
 

data/lib/generators/beyond_api/install_generator.rb

@@ -3,7 +3,7 @@
 module BeyondApi
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../templates", __FILE__)
+      source_root File.expand_path("../templates", __dir__)
 
       def copy_initializer
         template "beyond_api_initializer.rb", "config/initializers/beyond_api.rb"

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: beyond_api
 version: !ruby/object:Gem::Version
-  version: 0.17.0.pre
+  version: 0.20.0.pre
 platform: ruby
 authors:
 - Unai Abrisketa
 - Kathia Salazar
 - German San Emeterio
 - Kenneth Gallego
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-12 00:00:00.000000000 Z
+date: 2021-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -27,6 +27,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -56,7 +84,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop-ordered_methods
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -70,55 +112,57 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
-description:
-email:
+        version: 1.8.0
+description: 
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.template"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
@@ -184,7 +228,7 @@ files:
 homepage: https://github.com/ePages-de/beyond_api-ruby_client
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -199,8 +243,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Ruby client to access the Beyond API
 test_files: []