cass-fmadata-client 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 18a987d2d1861c4756ba663387c9bbe9e4e78c4406b37230e6104b504eb46b9d
+  data.tar.gz: 2e262e89f78afd028ac96ff3dbf7d4208a55e0624ab3cd712ee8e0a95645ce04
+SHA512:
+  metadata.gz: f7cfe638839f07737ce7c1b9cc18772042bde3ea11e09c9a0f6e91d59afd5906381006f7d8db1b9f8dfbf66e7abef2048d413cba9533733b8fb9544adbc6f4ee
+  data.tar.gz: af45a0e61737a9cd8688cc993f6799d7b7b827af8c85cfc7942213e6693773faa0a3d2b0aaa87f3d418d32904aa4eef6cce0d15f132f02f87016713d39d90c1b

data/lib/cass_fmadata_client/base.rb

@@ -0,0 +1,104 @@
+module CassClient
+  class Base
+    include Connection
+
+    def initialize(p={})
+      setup_connection(p)
+    end
+
+    def tiger(p = {})
+      send_request(p, tiger_url)
+    end
+
+    def city_county(p = {})
+      send_request(p, city_county_url)
+    end
+
+    def search_by_address(p = {})
+      send_request(p, search_by_address_url)
+    end
+
+    def state_county(p = {})
+      send_request(p, state_county_url)
+    end
+
+    def city_zip(p = {})
+      send_request(p, city_zip_url)
+    end
+
+    def address(p = {})
+      send_request(p, address_url)
+    end
+
+    private
+
+    def prepare_url(p, url)
+      uri = URI.parse(url)
+
+      #Add params to URI
+      uri.query = URI.encode_www_form(p)
+      uri
+    end
+
+    def send_request(p, url)
+      uri = prepare_url(p, url)
+
+      request = Net::HTTP::Get.new(uri)
+      request["Token"] = @token
+
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+
+      # set try_number for retry logic
+      try_number = 0
+      begin
+        Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+          response = http.request(request)
+
+          # raise error if the response is other than Success
+          raise CassFma::BadResponseError, response.class.name unless response.kind_of? Net::HTTPSuccess
+          response
+        end
+      rescue CassFma::BadResponseError => e
+        try_number += 1
+
+        # raise an error if max retries reached - it's neccessary to inform a client that there
+        # still is some issue with the service
+        raise(e, custom_error_message(e)) if try_number > @max_retries
+
+        sleep @retry_interval
+        retry
+      end
+    end
+
+    # Add some more specifically info to error message
+    def custom_error_message(e)
+      "#{e.message} (MAX_RETRIES reached)"
+    end
+
+    def tiger_url
+      @host + 'tiger/'
+    end
+
+    def city_county_url
+      @host + 'city-county/'
+    end
+
+    def search_by_address_url
+      @host + 'search-by-address/'
+    end
+
+    def state_county_url
+      @host + 'state-county/'
+    end
+
+    def city_zip_url
+      @host + 'city-zip/'
+    end
+
+    def address_url
+      @host + 'address/'
+    end
+  end
+end

data/lib/cass_fmadata_client/connection.rb

@@ -0,0 +1,31 @@
+module CassClient
+  # Connection module
+
+  module Connection
+    require 'uri'
+
+    DEFAULT_URL     = 'www.example.com'.freeze
+    DEFAULT_VERSION = '/api'.freeze
+    # retry logic defaults:
+    DEFAULT_MAX_RETRIES = 5
+    # retry interval in seconds
+    DEFAULT_RETRY_INTERVAL = 3
+
+    def setup_connection(p = {})
+      @host           = p[:host]            || DEFAULT_URL
+      @token          = p[:token]
+      @max_retries    = p[:max_retries]     || DEFAULT_MAX_RETRIES
+      @retry_interval = p[:retry_interval]  || DEFAULT_RETRY_INTERVAL
+    end
+
+    def headers
+      {
+        'Token': @token
+      }
+    end
+
+    def base_url
+      URI.parse(@host).to_s
+    end
+  end
+end

data/lib/cass_fmadata_client.rb

@@ -0,0 +1,10 @@
+require_relative 'cass_fmadata_client/connection'
+require_relative 'cass_fmadata_client/base'
+require 'dotenv/load'
+require 'net/http'
+require 'json'
+
+module CassFma
+  class Client < CassClient::Base; end
+  class BadResponseError < StandardError; end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: cass-fmadata-client
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Brian Long
+- Radosław Stolarski
+- Paweł Jermalonek
+- Ada Borzemska
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.24.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.24.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+description: Client for CASS API
+email: brian.long@firstmoversadvantage.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cass_fmadata_client.rb
+- lib/cass_fmadata_client/base.rb
+- lib/cass_fmadata_client/connection.rb
+homepage: https://www.fmadata.com/
+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.6
+signing_key: 
+specification_version: 4
+summary: Client for CASS API
+test_files: []