fantasticstay_api 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34e6c99e07ab528a63116a7bdfcd764a6cd74047f805ef2121c02f82b7266584
-  data.tar.gz: 4a2af7516ae2ae8385cf20acb58b282d72d9d52e8024df49f3f3db91fffc32c2
+  metadata.gz: 3edde0d39d9a83238e729e588238d8fbeffca50ea873da073de943729dcdca07
+  data.tar.gz: 3abc453bfc9599a7767eeb42534cbe99cc14a8484ae6a4cfb8b5bb3840c01339
 SHA512:
-  metadata.gz: 8be0b2d3027bdf240d35414d4800dfaaf13de5e2c06348dac2c7fbbf38670f362829b29ff898b4cd1c82ee34d17034c9b6ed686ebdaad735f5eabb235487da80
-  data.tar.gz: dced4169e85772446ba7441ea95da1d32f96f8e76d37aaa1a87b1c4aa72193c78a8d0f64334086505a3869050e48a8fc7f0ad85795ff08697d22747bb6e1156a
+  metadata.gz: df0c54d26a59fce2a7aa02b1c58fcc7234745213409ab8684194bcbd22332eacd1a2c0bc555b50d46ebc9803423619aa96a8af809d803bcbe4ff82db60ed638a
+  data.tar.gz: 68bc2fc9c89a243ed8a0e4162f6c10cbc4d8ad26d694abbd9853d0690f2fa3e92302faa7ffb7b3043f7c60c37a14d4bf1bf7dc78e8c63154f502e2cffe1e23c7

data/CHANGELOG.md

@@ -0,0 +1 @@
+* 0.1.5 Upgrade to faraday 2.6.0

data/Gemfile

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

data/Gemfile.lock

@@ -1,51 +1,56 @@
 PATH
   remote: .
   specs:
-    fantasticstay_api (0.1.0)
+    fantasticstay_api (0.1.5)
       api_cache (~> 0.3.0)
-      faraday (~> 1.3.0)
+      dry-configurable (~> 0.13)
+      faraday (~> 2.6.0)
       oj (~> 3.11)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     api_cache (0.3.0)
     ast (2.4.2)
+    concurrent-ruby (1.1.10)
     crack (0.4.5)
       rexml
-    diff-lcs (1.4.4)
-    dotenv (2.7.6)
-    faraday (1.3.0)
-      faraday-net_http (~> 1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords
-    faraday-net_http (1.0.1)
+    diff-lcs (1.5.0)
+    dry-configurable (0.16.1)
+      dry-core (~> 0.6)
+      zeitwerk (~> 2.6)
+    dry-core (0.9.1)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    faraday (2.6.0)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.1)
     hashdiff (1.0.1)
-    multipart-post (2.1.1)
-    oj (3.11.3)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    oj (3.13.21)
+    parallel (1.22.1)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    public_suffix (5.0.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
     rubocop (0.93.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
@@ -55,23 +60,23 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
-    unicode-display_width (1.7.0)
-    vcr (6.0.0)
-    webmock (3.12.2)
-      addressable (>= 2.3.6)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (1.8.0)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.6.1)
 
 PLATFORMS
   aarch64-linux
   x86_64-linux
 
 DEPENDENCIES
-  dotenv (~> 2.7)
   fantasticstay_api!
   rake (~> 13.0)
   rspec (~> 3.0)

data/bin/console

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'dotenv/load'
 require 'fantasticstay_api'
 
 # You can add fixtures and/or initialization code here to make experimenting

data/fantasticstay_api.gemspec

@@ -32,10 +32,10 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
   spec.add_dependency 'api_cache', '~> 0.3.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.13'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/fantasticstay_api/api.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require_relative 'api_exceptions'
-require_relative 'configuration'
 require_relative 'constants'
 require_relative 'http_status_codes'
+require 'dry-configurable'
 require 'api_cache'
 require 'digest/bubblebabble'
 
@@ -13,20 +13,7 @@ module FantasticstayApi
     include ApiExceptions
     include Constants
     include HttpStatusCodes
-
-    attr_reader(*FantasticstayApi.configuration.property_names)
-
-    attr_accessor :current_options
-
-    # Callback to update current configuration options
-    class_eval do
-      FantasticstayApi.configuration.property_names.each do |key|
-        define_method "#{key}=" do |arg|
-          instance_variable_set("@#{key}", arg)
-          current_options.merge!({ "#{key}": arg })
-        end
-      end
-    end
+    include Dry::Configurable
 
     HTTP_STATUS_MAPPING = {
       HTTP_BAD_REQUEST_CODE => BadRequestError,
@@ -36,16 +23,37 @@ module FantasticstayApi
       HTTP_UNPROCESSABLE_ENTITY_CODE => UnprocessableEntityError,
       'default' => ApiError
     }.freeze
+    API_ENDPOINT = 'https://api.fsapp.io'
+    API_TOKEN = 'TESTING'
+
+    setting :follow_redirects, default: true
+
+    # The api endpoint used to connect to FantasticstayApi if none is set
+    setting :endpoint, default: ENV['FANTASTICSTAY_API_ENDPOINT'] || API_ENDPOINT, reader: true
+
+    # The token included in request header 'x-api-key'
+    setting :token, default: ENV['FANTASTICSTAY_API_TOKEN'] || API_TOKEN, reader: true
+
+    # The value sent in the http header for 'User-Agent' if none is set
+    setting :user_agent, default: "FantasticstayApi API Ruby Gem #{FantasticstayApi::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: 10
+
+    # Add Faraday::RackBuilder to overwrite middleware
+    setting :stack
 
     # Create new API
     #
     # @api public
     def initialize(options = {}, &block)
-      opts = FantasticstayApi.configuration.fetch.merge(options)
-      @current_options = opts
-
-      FantasticstayApi.configuration.property_names.each do |key|
-        send("#{key}=", opts[key])
+      configure do |c|
+        options.each_key do |key|
+          c.send("#{key}=", options[key])
+        end
       end
 
       yield_or_eval(&block) if block_given?
@@ -63,29 +71,28 @@ module FantasticstayApi
     private
 
     def client
-      # 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.adapter Faraday.default_adapter
         client.headers['Content-Type'] = 'application/json'
-        client.headers['x-api-key'] = @token
-        client.headers['User-Agent'] = @user_agent
-        client.response :logger, logger
+        client.headers['x-api-key'] = config.token
+        client.headers['User-Agent'] = config.user_agent
       end
     end
 
     def request(http_method:, endpoint:, params: {}, cache_ttl: 3600)
       response = APICache.get(
-        Digest::SHA256.bubblebabble(@token) + http_method.to_s + endpoint + params.to_s,
+        Digest::SHA256.bubblebabble(config.token) + http_method.to_s + endpoint + params.to_s,
         cache: cache_ttl
       ) do
         client.public_send(http_method, endpoint, params)
       end
-      parsed_response = Oj.load(response.body)
 
-      return parsed_response if response_successful?(response)
+      process_http_response(response)
+    end
+
+    def process_http_response(response)
+      return Oj.load(response.body) if response_successful?(response)
 
       raise error_class(response), "Code: #{response.status}, response: #{response.body}"
     end
@@ -101,24 +108,5 @@ module FantasticstayApi
     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

data/lib/fantasticstay_api/client.rb

@@ -82,6 +82,17 @@ module FantasticstayApi
       process_response(response)
     end
 
+    # FantasticstayApi::Client.new.search(query)
+    def search(query, type = nil, global_params = {})
+      response = request(
+        http_method: :get,
+        endpoint: 'search',
+        params: { q: query, type: type }.merge!(global_params),
+        cache_ttl: 3600 * 24
+      )
+      process_response(response)
+    end
+
     protected
 
     def process_response(response)

data/lib/fantasticstay_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FantasticstayApi
-  VERSION = '0.1.3'
+  VERSION = '0.1.6'
 end

data/lib/fantasticstay_api.rb

@@ -13,35 +13,6 @@ module FantasticstayApi
   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
-    #   FantasticstayApi.configure do |c|
-    #     c.some_option = true
-    #   end
-    #
-    # @yield the configuration block
-    # @yieldparam configuration [FantasticstayApi::Configuration]
-    #   the configuration instance
-    #
-    # @return [nil]
-    #
-    # @api public
-    def configure
-      yield configuration
-    end
-
     # Alias for FantasticstayApi::Client.new
     #
     # @param [Hash] options
@@ -70,20 +41,15 @@ module FantasticstayApi
     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)
-        FantasticstayApi.configuration.send(method_name, *args, &block)
       else
         super.respond_to_missing?
       end
     end
 
     def respond_to_missing?(method_name, include_private = false)
-      new.respond_to?(method_name, include_private) ||
-        configuration.respond_to?(method_name) ||
-        super(method_name, include_private)
+      new.respond_to?(method_name, include_private) || super(method_name, include_private)
     end
   end
 end
 
 require_relative 'fantasticstay_api/client'
-require_relative 'fantasticstay_api/configuration'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fantasticstay_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.6
 platform: ruby
 authors:
 - Dinis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-27 00:00:00.000000000 Z
+date: 2022-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api_cache
@@ -30,14 +30,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
@@ -52,6 +52,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.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 description: A gem that implements functions from the FS API available for its users.
 email:
 - dinis@lage.pw
@@ -77,12 +91,8 @@ files:
 - fantasticstay_api.gemspec
 - lib/fantasticstay_api.rb
 - lib/fantasticstay_api/api.rb
-- lib/fantasticstay_api/api/config.rb
-- lib/fantasticstay_api/api/config/property.rb
-- lib/fantasticstay_api/api/config/property_set.rb
 - lib/fantasticstay_api/api_exceptions.rb
 - lib/fantasticstay_api/client.rb
-- lib/fantasticstay_api/configuration.rb
 - lib/fantasticstay_api/constants.rb
 - lib/fantasticstay_api/http_status_codes.rb
 - lib/fantasticstay_api/version.rb

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module FantasticstayApi
-  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/fantasticstay_api/api/config/property_set.rb

@@ -1,119 +0,0 @@
-# frozen_string_literal: true
-
-require 'set'
-
-module FantasticstayApi
-  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/fantasticstay_api/api/config.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'config/property'
-require_relative 'config/property_set'
-
-module FantasticstayApi
-  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/fantasticstay_api/configuration.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'api/config'
-require_relative 'version'
-
-module FantasticstayApi
-  # Stores the configuration
-  class Configuration < API::Config
-    API_ENDPOINT = 'https://api.fsapp.io'
-    API_TOKEN = 'TESTING'
-
-    property :follow_redirects, default: true
-
-    # The api endpoint used to connect to FantasticstayApi if none is set
-    property :endpoint, default: ENV['FANTASTICSTAY_API_ENDPOINT'] || API_ENDPOINT
-
-    # The token included in request header 'x-api-key'
-    property :token, default: ENV['FANTASTICSTAY_API_TOKEN'] || API_TOKEN
-
-    # The value sent in the http header for 'User-Agent' if none is set
-    property :user_agent, default: "FantasticstayApi API Ruby Gem #{FantasticstayApi::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: 10
-
-    # Add Faraday::RackBuilder to overwrite middleware
-    property :stack
-  end
-end