fantasticstay_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6d5c86f2b9a796698def2e4b8801e4801de74335ac43f5e9bc2939814105cba
-  data.tar.gz: e9f2c55526493914d927c03c4830a8d46024fe38abe6b66a04a15418d5e532a7
+  metadata.gz: bdecfb00c6c09a2e935ade7f958df01b634928f4c6bb46baa6d6e0992c01ffaa
+  data.tar.gz: ac032f6927c1b9769224c88008b10c6442c00b0e685b343081e96fd7b651c1f1
 SHA512:
-  metadata.gz: ee9371e6284a6ec29a4275ee1a28fe430e9604125e3d2ad9c29ff3946d27290e936830ff8cb875dd285ee02ff7fedcde8576012b01b2b84c01fd93a25af52e5b
-  data.tar.gz: '09de71f00f8d730c8eb8416703e10f8c4d028123ce150fa7fa9ae860e2be9a5d55fc215cec2a3feb381b524f5e4b03e9b073c56aff9cc555c5971875e4fc6ee5'
+  metadata.gz: 75c5256ada0d0a1f1b3098ce474820fa6e67a5ca5d997fbab9682be27e745903ea2879dc97797bd940c3f5601c926fe672f053b6adb4b00e8e07bc8657287973
+  data.tar.gz: 47658f8667df190a20bcb052a6bb2de69fc3b0ad90fb69c08777a6f47e2fa1e906bb5431ef349cb81a2ebf57d856bb6b523ef5d7bb916eff74030b2fd2d4d4b0

data/Gemfile.lock

@@ -2,6 +2,7 @@ PATH
   remote: .
   specs:
     fantasticstay_api (0.1.0)
+      api_cache (~> 0.3.0)
       faraday (~> 1.3.0)
       oj (~> 3.11)
 
@@ -10,6 +11,7 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    api_cache (0.3.0)
     ast (2.4.2)
     crack (0.4.5)
       rexml

data/fantasticstay_api.gemspec

@@ -33,6 +33,8 @@ Gem::Specification.new do |spec|
   # spec.add_dependency "example-gem", "~> 1.0"
   spec.add_dependency 'faraday', '~> 1.3.0'
   spec.add_dependency 'oj', '~> 3.11'
+  spec.add_dependency 'api_cache', '~> 0.3.0'
+
   # spec.add_dependency 'dry-configurable', '~> 0.12.1'
 
   # For more information and examples about making a new gem, checkout our

data/lib/fantasticstay_api/api.rb

@@ -4,6 +4,8 @@ require_relative 'api_exceptions'
 require_relative 'configuration'
 require_relative 'constants'
 require_relative 'http_status_codes'
+require 'api_cache'
+require 'digest/bubblebabble'
 
 module FantasticstayApi
   # Core class responsible for api interface operations
@@ -70,13 +72,16 @@ module FantasticstayApi
       @client ||= Faraday.new(@api_endpoint) do |client|
         client.request :url_encoded
         client.adapter Faraday.default_adapter
+        client.headers['Content-Type'] = 'application/json'
         client.headers['x-api-key'] = @api_token
         client.response :logger, logger
       end
     end
 
-    def request(http_method:, endpoint:, params: {})
-      response = client.public_send(http_method, endpoint, params)
+    def request(http_method:, endpoint:, params: {}, cache_ttl: 3600)
+      response = APICache.get(Digest::SHA256.bubblebabble(@api_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)

data/lib/fantasticstay_api/client.rb

@@ -1,21 +1,27 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'logger'
 require_relative 'api'
 
 module FantasticstayApi
   # Main client class that implements communication with the API
+  # global_params:
+  # - include_related_objects: int	0-1	0
+  # - page: int	positive	1
+  # - per_page: int	positive	20
   class Client < API
-    def listings
+    def listings(global_params = {})
       response = request(
         http_method: :get,
-        endpoint: 'listings'
+        endpoint: 'listings',
+        params: global_params
       )
-      process_response(response, 'listings')
+      process_response(response)
     end
 
     # FantasticstayApi::Client.new.calendar(38859, '2022-01-01', '2022-07-31')
-    def calendar(listing_id, start_date = nil, end_date = nil, filters = {})
+    def calendar(listing_id, start_date = nil, end_date = nil, filters = {}, global_params = {})
       response = request(
         http_method: :get,
         endpoint: 'calendar',
@@ -23,65 +29,80 @@ module FantasticstayApi
           listing_id: listing_id,
           start_date: start_date,
           end_date: end_date,
-          filters: filters
-        }
+          filters: filters.to_json
+        }.merge(global_params)
       )
-      process_response(response, 'calendar')
+      process_response(response)
+    end
+
+    def listing(listing_id, global_params = {})
+      response = request(
+        http_method: :get,
+        endpoint: "listings/#{listing_id}",
+        params: global_params
+      )
+      process_response(response)
     end
 
     # FantasticstayApi::Client.new.reservations(38859)
-    def reservations(listing_id, filters = {}, sort = {})
+    def reservations(listing_id, filters = [], sort = nil, global_params = {})
       response = request(
         http_method: :get,
         endpoint: 'reservations',
         params: {
           listing_id: listing_id,
-          filters: filters,
+          filters: filters.to_json,
           sort: sort
-        }
+        }.merge!(global_params),
+        cache_ttl: 3600*24
       )
-      process_response(response, 'reservations')
+      process_response(response)
     end
 
-    def reservation(reservation_id, filters = {}, sort = {})
+    def reservation(reservation_id, global_params = {})
       response = request(
         http_method: :get,
-        endpoint: sprintf('reservations/%d', reservation_id)
+        endpoint: "reservations/#{reservation_id}",
+        params: global_params
       )
-      process_single(response, 'reservation')
+      process_response(response)
     end
 
-    def guest(guest_id, filters = {}, sort = {})
+    def guest(guest_id, global_params = {})
       response = request(
         http_method: :get,
-        endpoint: sprintf('guests/%d', guest_id)
+        endpoint: "guests/#{guest_id}",
+        params: global_params,
+        cache_ttl: 3600*24
       )
-      process_single(response, 'guest')
+      process_response(response)
     end
 
-    def integrations
+    def integrations(global_params = {})
       response = request(
         http_method: :get,
-        endpoint: 'integrations'
+        endpoint: 'integrations',
+        params: global_params
       )
-      process_response(response, 'integrations')
+      process_response(response)
     end
 
     protected
 
-    def process_response(response, model = 'results')
-      results = response[model]
-      results.each do |r|
-        r.transform_keys!(&:to_sym)
+    def process_response(response)
+      result = response
+      case result
+      when Hash
+        result.transform_keys!(&:to_sym)
+        result.values.each do |r|
+          process_response(r)
+        end
+      when Array
+        result.each do |r|
+          process_response(r)
+        end
       end
-      total = response.key?('total') ? response['total'] : 1
-      { model.to_sym => results, total: total }
-    end
-
-    def process_single(response, model = 'result')
-      result = response[model]
-      result.transform_keys!(&:to_sym)
-      { model.to_sym => result }
+      result
     end
   end
 end

data/lib/fantasticstay_api/configuration.rb

@@ -9,7 +9,7 @@ module FantasticstayApi
     property :follow_redirects, default: true
 
     # The api endpoint used to connect to FantasticstayApi if none is set
-    property  :endpoint, default: 'https://api.fsapp.io'
+    property  :endpoint, default: 'https://api.fsapp.io/'
 
     # The value sent in the http header for 'User-Agent' if none is set
     property  :user_agent, default: "FantasticstayApi API Ruby Gem #{FantasticstayApi::VERSION}"

data/lib/fantasticstay_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fantasticstay_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dinis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-11 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: api_cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 description: A gem that implements functions from the FS API available for its users.
 email:
 - dinis@lage.pw