transparent_ruby_client 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ccee1fb51ee40e78809ab8e96a30f8a990455f185311c67f4836427b4993381
+  data.tar.gz: cec0fb6f56a30a642cb699e3fa155a8a40d9967604972ddc448e98a8582009de
+SHA512:
+  metadata.gz: b9f66d5647e3b37bb0023eb2f752316274627ef2bafb0c6597265048293473b4687511efcb26c0f24d747d2244278df0735f18e503e31d6544be4acc44f68873
+  data.tar.gz: 9832dc271e300d2b16f7a9148b5e2616c19d74679d6623c60bf884940e1c9e1b5227ddf69787a0e866bec559444ef64ccdea0e98557e0da3f01da7adadf49eb9

data/lib/transparent/client.rb

@@ -0,0 +1,179 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'transparent/constants'
+require 'sorbet-runtime'
+
+module Transparent
+  # API wrapper/client
+  class Client
+    extend T::Sig
+
+    sig do
+      params(
+        latitude: Float,
+        longitude: Float,
+        radius_meters: Integer,
+        type: String,
+        subtype: String,
+        bedrooms: T.nilable(T::Array[T.untyped]),
+        bathrooms: T.nilable(T::Array[T.untyped]),
+        capacity: T.nilable(T::Array[T.untyped]),
+        pool: T.nilable(T::Boolean),
+        air_conditioning: T.nilable(T::Boolean),
+        kid_friendly: T.nilable(T::Boolean),
+        parking: T.nilable(T::Boolean),
+        hot_tub: T.nilable(T::Boolean),
+        active_days: T.nilable(T::Boolean)
+      ).returns(Hash)
+    end
+    def initialize(
+      latitude:,
+      longitude:,
+      radius_meters:,
+      type:,
+      subtype:,
+      bedrooms: [],
+      bathrooms: [],
+      capacity: [],
+      pool: nil,
+      air_conditioning: nil,
+      kid_friendly: nil,
+      parking: nil,
+      hot_tub: nil,
+      active_days: nil
+    )
+      @latitude = latitude
+      @longitude = longitude
+      @radius_meters = radius_meters
+      @type = type
+      @subtype = subtype
+
+      @optional_params = {
+        bedrooms: normalise_list(bedrooms),
+        bathrooms: normalise_list(bathrooms),
+        capacity: normalise_list(capacity),
+        pool: normalise_boolean(pool),
+        air_conditioning: normalise_boolean(air_conditioning),
+        kid_friendly: normalise_boolean(kid_friendly),
+        parking: normalise_boolean(parking),
+        hot_tub: normalise_boolean(hot_tub),
+        active_days: active_days
+      }.select do |_key, value|
+        value && !value.to_s.empty?
+      end
+    end
+
+    def aggregated
+      aggregated_request.run
+
+      return { fulfilled: false } if aggregated_response.body.empty? || !aggregated_response.success?
+
+      {
+        fulfilled: true,
+        data: {
+          adr: aggregated_object['year_average_adr'],
+          occupancy: aggregated_object['year_average_occupancy']
+        }
+      }
+    end
+
+    def combined
+      parallel_listings_and_aggregated_requests.run
+
+      return { fulfilled: false } unless both_responses_are_good?
+
+      {
+        fulfilled: true,
+        data: {
+          adr: aggregated_object['year_average_adr'],
+          occupancy: aggregated_object['year_average_occupancy'],
+          listings: listings_object.map do |listing|
+            {
+              adr: listing['year_total_revenue'].to_f / listing['active_days'],
+              occupancy: listing['year_total_occupancy']
+            }
+          end
+        }
+      }
+    end
+
+    private
+
+    attr_reader :latitude, :longitude, :radius_meters, :type, :subtype, :optional_params
+
+    def normalise_list(value)
+      T.must(value).join(',')
+    end
+
+    def normalise_boolean(value)
+      return nil unless value
+
+      !!value ? 1 : 0
+    end
+
+    def both_responses_are_good?
+      [aggregated_response, listings_response].all?(&:success?) &&
+        [aggregated_response, listings_response].none? { |r| r.body.empty? }
+    end
+
+    def parallel_listings_and_aggregated_requests
+      return @hydra if @hydra
+
+      @hydra = Typhoeus::Hydra.new
+      @hydra.queue(listings_request)
+      @hydra.queue(aggregated_request)
+      @hydra
+    end
+
+    def aggregated_object
+      @aggregated_object ||= JSON.parse(aggregated_response.body)
+    end
+
+    def listings_object
+      @listings_object ||= JSON.parse(listings_response.body)
+    end
+
+    def aggregated_response
+      @aggregated_response ||= aggregated_request.response
+    end
+
+    def listings_response
+      @listings_response ||= listings_request.response
+    end
+
+    def listings_request
+      @listings_request ||= Typhoeus::Request.new(
+        Constants::BASE_URI + Constants::ENDPOINT_URIS[:listings],
+        method: :get,
+        headers: {
+          apikey: Transparent.configuration.apikey
+        },
+        params: {
+          latitude: latitude,
+          longitude: longitude,
+          radius_meters: radius_meters,
+          type: type,
+          subtype: subtype
+        }.merge(optional_params)
+      )
+    end
+
+    def aggregated_request
+      @aggregated_request ||= Typhoeus::Request.new(
+        Constants::BASE_URI + Constants::ENDPOINT_URIS[:aggregated],
+        method: :get,
+        headers: {
+          apikey: Transparent.configuration.apikey
+        },
+        params: {
+          latitude: latitude,
+          longitude: longitude,
+          radius_meters: radius_meters,
+          type: type,
+          subtype: subtype
+        }.merge(optional_params)
+      )
+    end
+  end
+end

data/lib/transparent/configuration.rb

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+module Transparent
+  class MissingConfiguration < StandardError; end
+
+  # API configuration
+  class Configuration
+    attr_writer :apikey
+
+    def apikey
+      raise MissingConfiguration unless @apikey
+
+      @apikey
+    end
+  end
+end

data/lib/transparent/constants.rb

@@ -0,0 +1,13 @@
+# typed: true
+# frozen_string_literal: true
+
+# This module will expose the API client
+module Transparent
+  module Constants
+    BASE_URI = 'https://listingroiapi.seetransparent.com/'
+    ENDPOINT_URIS = {
+      aggregated: 'aggregated',
+      listings: 'listings'
+    }.freeze
+  end
+end

data/lib/transparent.rb

@@ -0,0 +1,16 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'transparent/configuration'
+require 'transparent/client'
+
+# This module will expose the API client
+module Transparent
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: transparent_ruby_client
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Lavanda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: A ruby client for https://listingroiapi.seetransparent.com/
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/transparent.rb
+- lib/transparent/client.rb
+- lib/transparent/configuration.rb
+- lib/transparent/constants.rb
+homepage: https://rubygems.org/gems/transparent_ruby_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A ruby client for https://listingroiapi.seetransparent.com/
+test_files: []