moloni_api 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4ce20574d9044023df19c350c588d21ff192530da34e92b20185c70cf9fffe3
-  data.tar.gz: e40027e3826ea130df3e9f8ab435522958eb549232dc85c87e883c004c7daa93
+  metadata.gz: 6ec107d21be2536a63ab97fe0280cf8f7ad4db82759272e6f93a649224e869e3
+  data.tar.gz: 342955e233c5fb4ea13b0073f856701ce096b559d26229018efa3f17cbafee08
 SHA512:
-  metadata.gz: 0c94ad5acf50457127342b81d97f463a4874ea417232ff25dc954b3b69da1fe8338f4a533af16baf422577f7b3949ccf7b84f79fc3da050b2a12084949a79e37
-  data.tar.gz: 0f84659d5f1183ec4b4d75c0c6bf5eaa7ec1ffa2e86dfcaf2ef13c1bd4fc488646b2852df2b80c2764d5a5d4f65a35c2ac358a2222b591723ced38cc204241c3
+  metadata.gz: 52589d46b7dba75dbf5f15e938391c3fe65cf1571a35dd1029ff895e5ce2f61da690441d92829362e64840542f2d32c4aa2d108dac4d0136433ec0d8b5c1fb85
+  data.tar.gz: 998755fc207a05796be2664529ce81123fc141e4b26670e976600df7d36ab551ef9623bbde5a23be8c13438799c3c486de95d8d64b3d3599aade13ff4e613213

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+* 0.2.0 - Breaking change: initialization using a configure block now - dry-configurable
+* 0.1.5 - Passing tests

data/Gemfile

@@ -5,8 +5,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in moloni_api.gemspec
 gemspec
 
-gem 'dotenv', '~> 2.7'
-
 group :test do
   gem 'rake', '~> 13.0'
   gem 'rspec', '~> 3.0'

data/lib/moloni_api/api.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
+require 'dry-configurable'
 require_relative 'api_exceptions'
-require_relative 'configuration'
 require_relative 'constants'
 require_relative 'http_status_codes'
 require 'json'
@@ -12,21 +12,11 @@ module MoloniApi
     include ApiExceptions
     include Constants
     include HttpStatusCodes
+    include Dry::Configurable
 
-    attr_reader(*MoloniApi.configuration.property_names)
-
-    attr_accessor :current_options
-
-    # Callback to update current configuration options
-    class_eval do
-      MoloniApi.configuration.property_names.each do |key|
-        define_method "#{key}=" do |arg|
-          instance_variable_set("@#{key}", arg)
-          current_options.merge!({ "#{key}": arg })
-        end
-      end
-    end
-
+    API_ENDPOINT = 'https://api.moloni.pt/sandbox/'
+    API_CLIENT_ID = 'apigem'
+    API_CLIENT_SECRET = 'c9c9f4274658da2ad78b55a452894942898b5614'
     HTTP_STATUS_MAPPING = {
       HTTP_BAD_REQUEST_CODE => BadRequestError,
       HTTP_UNAUTHORIZED_CODE => UnauthorizedError,
@@ -36,19 +26,28 @@ module MoloniApi
       'default' => ApiError
     }.freeze
 
-    # Create new API
-    #
-    # @api public
-    def initialize(options = {}, &block)
-      opts = MoloniApi.configuration.fetch.merge(options)
-      @current_options = opts
+    setting :follow_redirects, default: true
 
-      MoloniApi.configuration.property_names.each do |key|
-        send("#{key}=", opts[key])
-      end
+    # The api endpoint used to connect to MoloniApi if none is set
+    # prd: https://api.moloni.pt/v1/
+    # sandbox: https://api.moloni.pt/sandbox/
+    setting :endpoint, default: ENV['MOLONI_API_ENDPOINT'] || API_ENDPOINT, reader: true
 
-      yield_or_eval(&block) if block_given?
-    end
+    # The value sent in the http header for 'User-Agent' if none is set
+    setting :user_agent, default: "MoloniApi API Ruby Gem #{MoloniApi::VERSION}"
+
+    # By default uses the Faraday connection options if none is set
+    setting :connection_options, default: {}
+
+    # By default display 30 resources
+    setting :per_page, default: 20
+
+    # Add Faraday::RackBuilder to overwrite middleware
+    setting :stack
+
+    setting :api_access_token, reader: true
+    setting :api_client_id, default: ENV['MOLONI_API_CLIENT_ID'] || API_CLIENT_ID, reader: true
+    setting :api_client_secret, default: ENV['MOLONI_API_CLIENT_SECRET'] || API_CLIENT_SECRET, reader: true
 
     # Call block with argument
     #
@@ -65,19 +64,19 @@ module MoloniApi
       # provide your own logger
       logger = Logger.new $stderr
       logger.level = Logger::DEBUG
-      @client ||= Faraday.new(@endpoint) do |client|
+      @client ||= Faraday.new(config.endpoint) do |client|
         client.request :url_encoded
         # client.request :json
         # client.response :json
         client.adapter Faraday.default_adapter
-        client.headers['User-Agent'] = @user_agent
+        client.headers['User-Agent'] = config.user_agent
         client.response :logger, logger
       end
     end
 
     def request(http_method:, endpoint:, params: {}, query_params: {}, add_access_token: true)
       if add_access_token
-        query_params[:access_token] = @api_access_token
+        query_params[:access_token] = self.api_access_token
         query_params[:json] = true
       end
       response = client.public_send(http_method, endpoint) do |req|
@@ -107,25 +106,6 @@ module MoloniApi
     def response_successful?(response)
       response.status == HTTP_OK_CODE
     end
-
-    # Responds to attribute query or attribute clear
-    #
-    # @api private
-    def method_missing(method_name, *args, &block)
-      # :nodoc:
-      case method_name.to_s
-      when /^(.*)\?$/
-        !send(Regexp.last_match(1).to_s).nil?
-      when /^clear_(.*)$/
-        send("#{Regexp.last_match(1)}=", nil)
-      else
-        super
-      end
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      method_name.to_s.start_with?('clear_') || super
-    end
   end
 end
 # mapi = MoloniApi.new(token: )

data/lib/moloni_api/client.rb

@@ -24,8 +24,8 @@ module MoloniApi
         endpoint: 'grant/',
         query_params: {
           grant_type: 'password',
-          client_id: @api_client_id,
-          client_secret: @api_client_secret,
+          client_id: self.api_client_id,
+          client_secret: self.api_client_secret,
           username: user_username,
           password: user_password
         },
@@ -43,14 +43,14 @@ module MoloniApi
         endpoint: 'grant/',
         query_params: {
           grant_type: 'refresh_token',
-          client_id: @api_client_id,
-          client_secret: @api_client_secret,
-          refresh_token: refresh_token || @api_refresh_token
+          client_id: self.api_client_id,
+          client_secret: self.api_client_secret,
+          refresh_token: refresh_token || self.api_refresh_token
         },
         add_access_token: false
       )
       res = process_response(response)
-      @api_access_token = res[:access_token]
+      self.api_access_token = res[:access_token]
       res
     end
 

data/lib/moloni_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MoloniApi
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

data/lib/moloni_api.rb

@@ -13,45 +13,13 @@ module MoloniApi
   LIBDIR = File.expand_path(LIBNAME.to_s, __dir__)
 
   class << self
-    # The client configuration
-    #
-    # @return [Configuration]
-    #
-    # @api public
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    alias config configuration
-
-    # Configure options
-    #
-    # @example
-    #   MoloniApi.configure do |c|
-    #     c.some_option = true
-    #   end
-    #
-    # @yield the configuration block
-    # @yieldparam configuration [MoloniApi::Configuration]
-    #   the configuration instance
-    #
-    # @return [nil]
-    #
-    # @api public
-    def configure
-      yield configuration
-    end
-
     # Alias for MoloniApi::Client.new
     #
-    # @param [Hash] options
-    #   the configuration options
-    #
     # @return [MoloniApi::Client]
     #
     # @api public
-    def new(options = {}, &block)
-      Client.new(options, &block)
+    def new
+      Client.new
     end
 
     # Default middleware stack that uses default adapter as specified
@@ -70,8 +38,8 @@ module MoloniApi
     def method_missing(method_name, *args, &block)
       if new.respond_to?(method_name)
         new.send(method_name, *args, &block)
-      elsif configuration.respond_to?(method_name)
-        MoloniApi.configuration.send(method_name, *args, &block)
+      elsif new.config.respond_to?(method_name)
+        MoloniApi::Client.config.send(method_name, *args, &block)
       else
         super.respond_to_missing?
       end
@@ -86,4 +54,3 @@ module MoloniApi
 end
 
 require_relative 'moloni_api/client'
-require_relative 'moloni_api/configuration'

data/moloni_api.gemspec

@@ -31,9 +31,9 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
-  spec.add_dependency 'faraday', '~> 1.3.0'
+  spec.add_dependency 'faraday', '~> 2.6.0'
   spec.add_dependency 'oj', '~> 3.11'
-  # spec.add_dependency 'dry-configurable', '~> 0.12.1'
+  spec.add_dependency 'dry-configurable', '~> 0.16'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moloni_api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Dinis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-27 00:00:00.000000000 Z
+date: 2022-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 description: A gem that implements functions from the Moloni API available for its
   users.
 email:
@@ -64,12 +78,8 @@ files:
 - docker-compose.yml
 - lib/moloni_api.rb
 - lib/moloni_api/api.rb
-- lib/moloni_api/api/config.rb
-- lib/moloni_api/api/config/property.rb
-- lib/moloni_api/api/config/property_set.rb
 - lib/moloni_api/api_exceptions.rb
 - lib/moloni_api/client.rb
-- lib/moloni_api/configuration.rb
 - lib/moloni_api/constants.rb
 - lib/moloni_api/http_status_codes.rb
 - lib/moloni_api/models/product.rb

data/lib/moloni_api/api/config/property.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module MoloniApi
-  class API
-    class Config
-      # Property objects provide an interface for configuration options
-      class Property
-        attr_reader :name, :default, :required
-
-        def initialize(name, options)
-          @name = name
-          @default = options.fetch(:default, nil)
-          @required = options.fetch(:required, nil)
-          @options = options
-        end
-
-        # @api private
-        def define_accessor_methods(properties)
-          properties.define_reader_method(self, name, :public)
-          properties.define_writer_method(self, "#{name}=", :public)
-        end
-      end
-    end
-  end
-end

data/lib/moloni_api/api/config/property_set.rb

@@ -1,119 +0,0 @@
-# frozen_string_literal: true
-
-require 'set'
-
-module MoloniApi
-  class API
-    class Config
-      # Class responsible for storing configuration properties
-      class PropertySet
-        include Enumerable
-
-        attr_reader :parent, :properties
-
-        # Initialize an PropertySet
-        #
-        # @param [Object] parent
-        # @param [Set] properties
-        #
-        # @return [undefined]
-        #
-        # @api private
-        def initialize(parent = nil, properties = Set.new)
-          @parent = parent
-          @properties = properties
-          @map = {}
-        end
-
-        # Iterate over properties
-        #
-        # @yield [property]
-        #
-        # @yieldparam [Property] property
-        #
-        # @return [self]
-        #
-        # @api public
-        def each
-          return to_enum unless block_given?
-
-          @map.each { |name, property| yield property if name.is_a?(Symbol) }
-          self
-        end
-
-        # Adds property to the set
-        #
-        # @example
-        #   properties_set << property
-        #
-        # @param [Property] property
-        #
-        # @return [self]
-        #
-        # @api public
-        def <<(property)
-          properties << property
-          update_map(property.name, property.default)
-          property.define_accessor_methods(self)
-          self
-        end
-
-        # Access property by name
-        #
-        # @api public
-        def [](name)
-          @map[name]
-        end
-        alias fetch []
-
-        # Set property value by name
-        #
-        # @api public
-        def []=(name, property)
-          update_map(name, property)
-        end
-
-        # Update map with index
-        #
-        # @api private
-        def update_map(name, property)
-          @map[name.to_sym] = @map[name.to_s.freeze] = property
-        end
-
-        # Convert properties to a hash of property names and
-        # corresponding values
-        #
-        # @api public
-        def to_hash
-          properties.each_with_object({}) do |property, props|
-            name = property.name
-            props[name] = self[name]
-          end
-        end
-
-        # Check if properties exist
-        #
-        # @api public
-        def empty?
-          @map.empty?
-        end
-
-        # @api private
-        def define_reader_method(property, method_name, visibility)
-          property_set = self
-          parent.send(:define_method, method_name) { property_set[property.name] }
-          parent.send(visibility, method_name)
-        end
-
-        # @api private
-        def define_writer_method(property, method_name, visibility)
-          property_set = self
-          parent.send(:define_method, method_name) do |value|
-            property_set[property.name] = value
-          end
-          parent.send(visibility, method_name)
-        end
-      end
-    end
-  end
-end

data/lib/moloni_api/api/config.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'config/property'
-require_relative 'config/property_set'
-
-module MoloniApi
-  class API
-    # A base class for constructing api configuration
-    class Config
-      # Defines a property on an object's class or instance
-      #
-      # @example
-      #   class Configuration < Api::Config
-      #     property :adapter, default: :net_http
-      #     property :user, required: true
-      #   end
-      #
-      # @param [Symbol] name
-      #   the name of a property
-      #
-      # @param [#to_hash] options
-      #   the extra options
-      #
-      # @return [self]
-      #
-      # @api public
-      def self.property(name, options = {})
-        property_set << Property.new(name, options)
-        update_subclasses(name, options)
-        self
-      end
-
-      def self.update_subclasses(name, options)
-        @subclasses.each { |klass| klass.property(name, options) } if defined?(@subclasses) && @subclasses
-      end
-
-      # Check if property is defined
-      #
-      # @param [Symbol] name
-      #   the name to check
-      #
-      # @return [Boolean]
-      #
-      # @api public
-      def self.property?(name)
-        property_set.include?(name)
-      end
-
-      class << self
-        attr_reader :property_set
-      end
-
-      instance_variable_set('@property_set', PropertySet.new(self))
-
-      def self.inherited(descendant)
-        super
-        (@subclasses ||= Set.new) << descendant
-        descendant.instance_variable_set(
-          '@property_set',
-          PropertySet.new(descendant, property_set.properties.dup)
-        )
-      end
-
-      def property_names
-        self.class.property_set.properties.map(&:name)
-      end
-
-      def self.property_names
-        property_set.properties.map(&:name)
-      end
-
-      # Fetch all the properties and their values
-      #
-      # @return [Hash[Symbol]]
-      #
-      # @api public
-      def fetch(value = nil)
-        if value
-          self.class.property_set[value]
-        else
-          self.class.property_set.to_hash
-        end
-      end
-
-      # Provide access to properties
-      #
-      # @example
-      #   config.call do |config|
-      #     config.adapter = :net_http
-      #   end
-      #
-      # @return [self]
-      #
-      # @api private
-      def call(&block)
-        block.call(self) if block_given?
-        self
-      end
-    end
-  end
-end

data/lib/moloni_api/configuration.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'api/config'
-require_relative 'version'
-
-module MoloniApi
-  # Stores the configuration
-  class Configuration < API::Config
-    API_ENDPOINT = 'https://api.moloni.pt/sandbox/'
-    API_CLIENT_ID = 'apigem'
-    API_CLIENT_SECRET = 'c9c9f4274658da2ad78b55a452894942898b5614'
-
-    property :follow_redirects, default: true
-
-    # The api endpoint used to connect to MoloniApi if none is set
-    # prd: https://api.moloni.pt/v1/
-    # sandbox: https://api.moloni.pt/sandbox/
-    property :endpoint, default: ENV['MOLONI_API_ENDPOINT'] || API_ENDPOINT
-
-    # The value sent in the http header for 'User-Agent' if none is set
-    property :user_agent, default: "MoloniApi API Ruby Gem #{MoloniApi::VERSION}"
-
-    # By default uses the Faraday connection options if none is set
-    property :connection_options, default: {}
-
-    # By default display 30 resources
-    property :per_page, default: 20
-
-    # Add Faraday::RackBuilder to overwrite middleware
-    property :stack
-
-    property :api_access_token
-    property :api_client_id, default: ENV['MOLONI_API_CLIENT_ID'] || API_CLIENT_ID
-    property :api_client_secret, default: ENV['MOLONI_API_CLIENT_SECRET'] || API_CLIENT_SECRET
-  end
-end