wrapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c98bc6c2eee387f249deb88ca115e68379a7b1e6fee7931440a3b0cecb5fcf0
+  data.tar.gz: d2a971caf861d8ab974ff2a4b29b886926021ac1297aea12b932336458daf9ee
+SHA512:
+  metadata.gz: a03c3c4c9c2ef461c5b2ab83ec791baaceb753569b87a1df32b42120b719c49b7f89b01fb98f80077fbb5a4a99f9824b4c7f156a81bcc5c721f53f471965458b
+  data.tar.gz: 19bdac9d4e22f1d9cbeda68e32146b6535ec49ee30f0684a5e250394aefd3fca03dbc0d2537708fee79ef556728b0e7ed0cd621dbcfec24941927d83762e86ba

data/.gitignore

@@ -0,0 +1,44 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/data/
+*.log
+*.txt
+*.json
+*.yml
+
+# Used by dotenv library to load environment variables.
+.env
+
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-2
+- Initial release extracted from CloudAlly gem

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cloudally.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rubocop', "~> 1.7'

data/README.md

@@ -0,0 +1,32 @@
+# Wrapper API 
+
+Some generic cody extracted from  by a number of api wrapper gems. Internal used only.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wrapi'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install wrapi
+
+## Usage
+
+See usage in integra365 gem https://github.com/jancotanis/integra365
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/wrapi.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+task default: %i[test rubocop]

data/lib/wrapi/api.rb

@@ -0,0 +1,32 @@
+require File.expand_path('configuration', __dir__)
+require File.expand_path('connection', __dir__)
+require File.expand_path('request', __dir__)
+require File.expand_path('authentication', __dir__)
+
+module WrAPI
+  # @private
+  class API
+    # @private
+    attr_accessor *WrAPI::Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API and copies settings from singleton
+    def initialize(options = {})
+      options = WrAPI.options.merge(options)
+      WrAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      WrAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    include WrAPI::Connection
+    include WrAPI::Request
+    include WrAPI::Authentication
+  end
+end

data/lib/wrapi/authentication.rb

@@ -0,0 +1,48 @@
+module WrAPI
+  # Deals with authentication flow and stores it within global configuration
+  # following attributes should be available:
+  #  username
+  #  password
+  #  access_token
+  #  token_type
+  #  refresh_token
+  #  token_expires
+
+  module Authentication
+    # Authorize to the portal and return access_token
+    def api_auth(path, options = {})
+      params = api_access_token_params.merge(options)
+      response = post(path, params)
+      # return access_token
+      api_process_token(response.body)
+    end
+
+    # Return an access token from authorization
+    def api_refresh(path, token)
+      params = { refreshToken: token }
+
+      response = post(path, params)
+      # return access_token
+      api_process_token(response.body)
+    end
+
+  private
+
+    def api_access_token_params
+      {
+        username: username,
+        password: password
+      }
+    end
+
+    def api_process_token(response)
+      at = self.access_token = response['accessToken']
+      self.token_type        = response['tokenType']
+      self.refresh_token     = response['refreshToken']
+      self.token_expires     = response['expiresIn']
+      raise StandardError.new 'Could not find valid accessToken; response ' + response.to_s if at.nil? || at.empty?
+
+      at
+    end
+  end
+end

data/lib/wrapi/configuration.rb

@@ -0,0 +1,84 @@
+require_relative './version'
+module WrAPI
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Integra365::API}
+
+    VALID_OPTIONS_KEYS = [
+      :access_token,
+      :token_type,
+      :refresh_token,
+      :token_expires,
+      :client_id,
+      :client_secret,
+      :connection_options,
+      :username,
+      :password,
+      :endpoint,
+      :logger,
+      :format,
+      :page_size,
+      :user_agent
+    ].freeze
+
+    # By default, don't set any connection options
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note There is no reason to use any other endpoint at this time
+    DEFAULT_ENDPOINT = 'https://api.com'.freeze
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is the only available format at this time
+    DEFAULT_FORMAT = :json
+
+    # The page size for paged rest responses
+    #
+    # @note default JSON is the only available format at this time
+    DEFAULT_PAGE_SIZE = 500
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Ruby API wrapper #{WrAPI::VERSION}".freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.access_token       = nil
+      self.token_type         = nil
+      self.refresh_token      = nil
+      self.token_expires      = nil
+      self.client_id          = nil
+      self.client_secret      = nil
+      self.username           = nil
+      self.password           = nil
+
+      self.logger             = nil
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.format             = DEFAULT_FORMAT
+      self.page_size          = DEFAULT_PAGE_SIZE
+      self.user_agent         = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/wrapi/connection.rb

@@ -0,0 +1,61 @@
+require 'faraday'
+
+module WrAPI
+  # Create connection including authorization parameters with default Accept format and User-Agent
+  # By default
+  # - Bearer authorization is access_token is not nil override with @setup_authorization
+  # - Headers setup for client-id and client-secret when client_id and client_secret are not nil @setup_headers
+  # @private
+  module Connection
+    private
+
+    def connection
+      options = setup_options
+
+      Faraday::Connection.new(options) do |connection|
+        connection.use Faraday::Response::RaiseError
+        connection.adapter Faraday.default_adapter
+        setup_authorization(connection)
+        setup_headers(connection)
+        connection.response :json, content_type: /\bjson$/
+        connection.use Faraday::Request::UrlEncoded
+
+        setup_logger_filtering(connection, logger) if logger
+      end
+    end
+
+    # callback method to setup api authorization
+    def setup_options()
+      {
+        headers: {
+          'Accept': "application/#{format}; charset=utf-8",
+          'User-Agent': user_agent
+        },
+        url: endpoint
+      }.merge(connection_options)
+    end
+
+    # callback method to setup api authorization
+    def setup_authorization(connection)
+      connection.authorization :Bearer, access_token if access_token
+    end
+
+    # callback method to setup api headers
+    def setup_headers(connection)
+      connection.headers['client-id'] = client_id if client_id
+      connection.headers['client-secret'] = client_secret if client_secret
+    end
+
+    # callback method to setup logger
+    def setup_logger_filtering(connection, logger)
+      connection.response :logger, logger, { headers: true, bodies: true } do |l|
+        # filter json content
+        l.filter(/("password":")(.+?)(".*)/, '\1[REMOVED]\3')
+        l.filter(/("accessToken":")(.+?)(".*)/, '\1[REMOVED]\3')
+        # filter header content
+        l.filter(/(client-secret:.)([^&]+)/, '\1[REMOVED]')
+        l.filter(/(Authorization:.)([^&]+)/, '\1[REMOVED]')
+      end
+    end
+  end
+end

data/lib/wrapi/entity.rb

@@ -0,0 +1,66 @@
+require 'json'
+
+module WrAPI
+  # Defines HTTP request methods
+  module Request
+    class Entity
+      attr_reader :attributes
+
+      def initialize(attributes)
+        @_raw = attributes
+
+        case attributes
+        when Hash
+          @attributes = attributes.clone.transform_keys(&:to_s)
+        when Array
+          # make deep copy
+          @attributes = entify(attributes)
+        else
+          @attributes = attributes.clone
+        end
+      end
+
+      def method_missing(method_sym, *arguments, &block)
+        len = arguments.length
+        # assignment
+        if (method = method_sym[/.*(?==\z)/m])
+          raise! ArgumentError, "wrong number of arguments (given #{len}, expected 1)", caller(1) unless len == 1
+
+          @attributes[method] = arguments[0]
+        elsif @attributes.include? method_sym.to_s
+          r = @attributes[method_sym.to_s]
+          case r
+          when Hash
+            @attributes[method_sym.to_s] = self.class.new(r)
+          when Array
+            # make deep copy
+            @attributes[method_sym.to_s] = r = entify(r)
+            r
+          else
+            r
+          end
+        else
+          @attributes.send(method_sym, *arguments, &block)
+        end
+      end
+
+      def respond_to?(method_sym, include_private = false)
+        if @attributes.include? method_sym.to_s
+          true
+        else
+          @attributes.respond_to?(method_sym, include_private)
+        end
+      end
+
+      def to_json(options = {})
+        @_raw.to_json
+      end
+      
+      def entify(a)
+        a.map do |item|
+          item.is_a?(Hash) ? self.class.new(item) : item
+        end if !a.empty? && a[0].is_a?(Hash)
+      end
+    end
+  end
+end

data/lib/wrapi/request.rb

@@ -0,0 +1,83 @@
+require 'uri'
+require 'json'
+require File.expand_path('entity', __dir__)
+
+module WrAPI
+  # Defines HTTP request methods
+  # required attributes format
+  module Request
+
+    # Perform an HTTP GET request and return entity incase format is :json
+    def get(path, options = {})
+      response = request(:get, path, options)
+      :json.eql?(format) ? Entity.new(response.body) : response.body
+    end
+
+    # Perform an HTTP GET request for paged date sets response ind to
+    # Name          Description
+    # pageSize      The number of records to display per page
+    # page          The page number
+    # nextPageToken Next page token
+    #
+    # response format { "page": 0, "totalPages": 0, "total": 0, "nextPageToken": "string", "data": [] }
+    def get_paged(path, options = {}, &block)
+      raise! ArgumentError,
+             "Pages requests should be json formatted (given format '#{format}')" unless :json.eql? format
+
+      result = []
+      page = 1
+      total = page + 1
+      next_page = ''
+      while page <= total
+        following_page = { pageSize: page_size }
+        following_page.merge!({ page: page, nextPageToken: next_page }) unless next_page.empty?
+
+        response = request(:get, path, options.merge(following_page))
+        data = response.body
+        d = data['data'].map { |e| Entity.new(e) }
+        if block_given?
+          yield(d)
+        else
+          result += d
+        end
+        page += 1
+        total = data['totalPages'].to_i
+        next_page = data['nextPageToken']
+      end
+      result unless block_given?
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options = {})
+      request(:post, path, options)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options = {})
+      request(:put, path, options)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options = {})
+      request(:delete, path, options)
+    end
+
+    private
+
+    # Perform an HTTP request
+    def request(method, path, options)
+      response = connection.send(method) do |request|
+        uri = URI::Parser.new
+        case method
+        when :get, :delete
+          request.url(uri.escape(path), options)
+        when :post, :put
+          request.headers['Content-Type'] = "application/#{format}"
+          request.path = uri.escape(path)
+          request.body = options.to_json unless options.empty?
+        end
+      end
+      response
+    end
+  end
+end

data/lib/wrapi/respond_to.rb

@@ -0,0 +1,16 @@
+
+module WrAPI
+  module RespondTo
+
+    # Delegate to Integra365::Client
+    def self.method_missing(method, *args, &block)
+      return super unless client.respond_to?(method)
+      client.send(method, *args, &block)
+    end
+
+    # Delegate to Integra365::Client
+    def self.respond_to?(method, include_all = false)
+      client.respond_to?(method, include_all) || super
+    end
+  end
+end

data/lib/wrapi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module WrAPI
+  VERSION = '0.1.0'
+end

data/lib/wrapi.rb

@@ -0,0 +1,26 @@
+require File.expand_path('wrapi/authentication', __dir__)
+require File.expand_path('wrapi/connection', __dir__)
+require File.expand_path('wrapi/configuration', __dir__)
+require File.expand_path('wrapi/api', __dir__)
+require File.expand_path('wrapi/request', __dir__)
+require File.expand_path('wrapi/entity', __dir__)
+require File.expand_path('wrapi/respond_to', __dir__)
+require File.expand_path('wrapi/version', __dir__)
+
+module WrAPI
+  extend RespondTo
+  extend Configuration
+
+  # Abstract method should be overridden
+  #
+  # @return client
+  def self.client(options = {})
+    raise NotImplementedError, 'Abstract method self.client must implemented when including ResponTo'
+  end
+
+  # set/override defaults
+  def self.reset
+    super
+    self.user_agent = "Ruby API wrapper #{WrAPI::VERSION}".freeze
+  end
+end

data/wrapi.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/wrapi/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'wrapi'
+  s.version     = WrAPI::VERSION
+  s.authors     = ['Janco Tanis']
+  s.email       = 'gems@jancology.com'
+  s.license     = 'MIT'
+
+  s.summary     = 'A Ruby api wrapper code extracted from real world api clients'
+  s.homepage    = 'https://rubygems.org/gems/wrapi'
+
+  s.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  s.metadata['homepage_uri'] = s.homepage
+  s.metadata['source_code_uri'] = 'https://github.com/jancotanis/wrapi'
+
+  # 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.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.platform = Gem::Platform::RUBY
+  s.add_runtime_dependency 'faraday'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: wrapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janco Tanis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: gems@jancology.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/wrapi.rb
+- lib/wrapi/api.rb
+- lib/wrapi/authentication.rb
+- lib/wrapi/configuration.rb
+- lib/wrapi/connection.rb
+- lib/wrapi/entity.rb
+- lib/wrapi/request.rb
+- lib/wrapi/respond_to.rb
+- lib/wrapi/version.rb
+- wrapi.gemspec
+homepage: https://rubygems.org/gems/wrapi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/wrapi
+  source_code_uri: https://github.com/jancotanis/wrapi
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.12
+signing_key:
+specification_version: 4
+summary: A Ruby api wrapper code extracted from real world api clients
+test_files: []