active_record_api-request 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d2693b81bbda9bd061fff4179384f6f644359d1012d9d12cabaf438025fc9f9
+  data.tar.gz: db410e238f262f295f164c6bb9b36557e0f2d0a6410cf582e83f4e80857930d0
+SHA512:
+  metadata.gz: 168799989e78b675825d3ace44ecee1b6edb367d67be77f4539da037a422160049bbfa7676b906fb6da2657119d266635012c6aad2107417e9d32532dc8718de
+  data.tar.gz: a1d03ed591e6530fe8d90a1734710bfa836fd30e821bcddbe92554da7a6f4e204c16aad58a2b96b9f1acf54b57c5f4d1ee2f4ec71f9088b7f7f7e323f01d22b0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 samuelbirk
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+# ActiveRecordApi::Request
+This is a library intended to make it easy to access services using the ActiveRecordApi::RestController gem.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_api-request'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install active_record_api-request
+```
+
+## Usage
+### Query [index action]
+```ruby
+ActiveRecordApi::Request::Methods.new(
+  host: 'https://advisor.beta.fullmeasureed.com/api', 
+  path: 'integrations/integrations', 
+  token: 'nfwv89n4wvb98bgb0ver87*******', 
+  debug: true
+  
+).query(params: {orginization_id: 1, type: 'IntegrationS3'})
+```
+
+### GET [show action]
+```ruby
+ActiveRecordApi::Request::Methods.new(
+  host: 'https://advisor.beta.fullmeasureed.com/api', 
+  path: 'integrations/integrations', 
+  token: 'nfwv89n4wvb98bgb0ver87*******', 
+  debug: true
+  
+).get(id: 1)
+```
+
+### POST [create action]
+```ruby
+ActiveRecordApi::Request::Methods.new(
+  host: 'https://advisor.beta.fullmeasureed.com/api', 
+  path: 'integrations/integrations', 
+  token: 'nfwv89n4wvb98bgb0ver87*******', 
+  debug: true
+).post(payload: {orginization_id: 1, type: 'IntegrationS3'})
+```
+
+### PUT [create action]
+```ruby
+ActiveRecordApi::Request::Methods.new(
+  host: 'https://advisor.beta.fullmeasureed.com/api', 
+  path: 'integrations/integrations', 
+  token: 'nfwv89n4wvb98bgb0ver87a*****', 
+  debug: true
+).put(id: 1, payload: {orginization_id: 1, type: 'IntegrationS3'})
+```
+## Authentication
+- If you have a token you can just provide it directly
+- Alternatively, you can provide a email and password
+    - NOTE: Make sure you also provide an environment variable for the token path
+```ruby
+ActiveRecordApi::Request::Methods.new(
+  host: 'https://advisor.beta.fullmeasureed.com/api', 
+  path: 'integrations/integrations', 
+  email: 'samuel.bi**@gmail.com', 
+  password: 'P@ss***', 
+).get(id: 1)
+```
+
+## Configuration
+- Many of the credentials can be provided via environment variables or Rails 5.2+ credentials
+
+### Environment Variables  
+```bash
+export ACTIVE_RECORD_API_REQUEST_HOST=https://advisor.beta.fullmeasureed.com/api
+export ACTIVE_RECORD_API_REQUEST_token=nfwv89n4wvb98bgb0ver87*******
+export ACTIVE_RECORD_API_REQUEST_EMAIL=samuel.bi**@gmail.com
+export ACTIVE_RECORD_API_REQUEST_PASSWORD=P@ss***
+export ACTIVE_RECORD_API_REQUEST_TOKEN_PATH=staff-auth/token
+```  
+### Rails 5.2+ Credentials
+```yaml
+active_record_api_request:
+    host: https://advisor.beta.fullmeasureed.com/api
+    token: nfwv89n4wvb98bgb0ver87*******
+    email: samuel.bi**@gmail.com
+    password: P@ss***
+    token_path: staff-auth/token
+```
+
+### GET using environment variables or credentials
+```ruby
+ActiveRecordApi::Request::Methods.new(
+  path: 'integrations/integrations', 
+).get(id: 1)
+```
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveRecordApi::Request'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'

data/lib/active_record_api/request.rb

@@ -0,0 +1,14 @@
+require 'active_support'
+
+module ActiveRecordApi
+  module Request
+    extend ActiveSupport::Autoload
+
+    autoload :VERSION
+    autoload :Methods
+    autoload :Credentials
+    autoload :Connection
+    autoload :FaradayFollowNextLinks
+    autoload :FaradayCacheServiceDown
+  end
+end

data/lib/active_record_api/request/connection.rb

@@ -0,0 +1,60 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday-http-cache'
+
+module ActiveRecordApi
+  module Request
+    class Connection < Credentials
+      attr_accessor :debug, :path, :cache_store
+      attr_writer :full_url
+
+      def authenticated_connection
+        connection.headers = connection.headers.merge(headers)
+        connection
+      end
+
+      def connection
+        @connection ||= Faraday.new do |builder|
+          builder.options[:open_timeout] = 2
+          builder.options[:timeout] = 5
+          builder.request :json
+          builder.request :url_encoded
+          builder.request :retry, max: 5, interval: 0.05, interval_randomness: 0.5, backoff_factor: 2
+          builder.use FaradayCacheServiceDown, cache_store
+          builder.use :http_cache, http_cache_options
+          builder.use FaradayFollowNextLinks, 5
+          builder.response :json, content_type: /\bjson$/
+          builder.response :raise_error
+          builder.response :logger if debug
+          builder.adapter Faraday.default_adapter
+        end
+      end
+
+      def full_url
+        @full_url ||= "#{strip_trailing_slash(host)}/#{strip_trailing_slash(path)}"
+      end
+
+      def full_url_with_params(params: {}, id: nil)
+        "#{full_url}/#{id}?#{params.to_query}"
+      end
+
+      def symbolize_response(response)
+        return response if response.is_a? String
+        if response.is_a? Array
+          return response if response.first.is_a? Array
+          response.map!(&:deep_symbolize_keys!)
+        else
+          response.try(:deep_symbolize_keys!)
+        end
+      end
+
+      def http_cache_options
+        { shared_cache: false, store: cache_store }
+      end
+
+      def strip_trailing_slash(string)
+        string.sub(%r{(\/)+$}, '')
+      end
+    end
+  end
+end

data/lib/active_record_api/request/credentials.rb

@@ -0,0 +1,48 @@
+require 'active_attr'
+
+module ActiveRecordApi
+  module Request
+    class Credentials
+      include ActiveAttr::Model
+      attr_writer :host, :token, :email, :password
+
+      def token
+        @token ||= config('token') || connection.post("#{host}/#{token_path}", credentials).body['access_token']
+      end
+
+      def host
+        @host ||= config(:host)
+      end
+
+      def token_path
+        @token_path ||= config(:token_path)
+      end
+
+      def email
+        @email ||= config(:email)
+      end
+
+      def password
+        @password ||= config(:password)
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{token}"
+        }
+      end
+
+      def credentials
+        {
+          email: email,
+          password: password,
+          grant_type: 'password'
+        }
+      end
+
+      def config(name)
+        ENV["ACTIVE_RECORD_API_REQUEST_#{name.upcase}"] || Rails.application.credentials.try(:active_record_api_request).try(:[], name)
+      end
+    end
+  end
+end

data/lib/active_record_api/request/faraday_cache_service_down.rb

@@ -0,0 +1,49 @@
+module ActiveRecordApi
+  module Request
+    class FaradayCacheServiceDown < Faraday::Middleware
+      attr_reader :cache
+      attr_reader :cache_identifier
+
+      def initialize(app, cache = nil, cache_identifier = 'empty')
+        super(app)
+        @cache = cache
+        @cache_identifier = cache_identifier
+      end
+
+      def call(env)
+        if :get == env[:method]
+          make_get_request(env)
+        else
+          @app.call(env)
+        end
+      end
+
+      def create_response(env)
+        hash = env.to_hash
+        {
+          status: hash[:status],
+          body: hash[:body],
+          response_headers: hash[:response_headers]
+        }
+      end
+
+      def make_get_request(env)
+        @app.call(env).on_complete do |response_env|
+          cache.write(cache_key(env), create_response(response_env))
+          response_env
+        end
+      rescue Faraday::TimeoutError
+        cached_response = cache.read(cache_key(env))
+        raise unless cached_response.present?
+        env.update(cached_response)
+        Faraday::Response.new(env)
+      end
+
+      def cache_key(env)
+        url = env[:url].dup
+        url.normalize!
+        "service_down:#{url.request_uri}:#{cache_identifier}"
+      end
+    end
+  end
+end

data/lib/active_record_api/request/faraday_follow_next_links.rb

@@ -0,0 +1,54 @@
+require 'faraday_middleware'
+
+module ActiveRecordApi
+  module Request
+    class FaradayFollowNextLinks < Faraday::Middleware
+      ENV_TO_CLEAR = %i[status response response_headers].to_set.freeze
+
+      attr_reader :max_pages
+
+      def initialize(app, max_pages = nil)
+        super(app)
+        @max_pages = max_pages
+      end
+
+      def call(env)
+        if :get == env[:method]
+          perform_with_next_links(env, max_pages)
+        else
+          @app.call(env)
+        end
+      end
+
+      def perform_with_next_links(env, max_pages_left)
+        request_body = env[:body]
+        response = @app.call(env)
+        response.on_complete do |response_env|
+          if next_link(env).present?
+            raise FaradayMiddleware::RedirectLimitReached, response if max_pages_left == 0
+            handle_response(env, request_body, response_env, max_pages_left)
+          end
+        end
+        response
+      end
+
+      def next_link(env)
+        env.response.headers.fetch('x-link-next', nil)
+      end
+
+      def handle_response(env, request_body, response_env, max_pages_left)
+        return unless env[:body].is_a?(Array)
+        new_request_env = update_env(response_env.dup, request_body, next_link(env))
+        max_pages_left -= 1 unless max_pages_left.nil?
+        env[:body] += perform_with_next_links(new_request_env, max_pages_left).body
+      end
+
+      def update_env(env, request_body, next_link)
+        env[:url] = URI.parse(next_link)
+        env[:body] = request_body
+        ENV_TO_CLEAR.each { |key| env.delete key }
+        env
+      end
+    end
+  end
+end

data/lib/active_record_api/request/methods.rb

@@ -0,0 +1,21 @@
+module ActiveRecordApi
+  module Request
+    class Methods < Connection
+      def query(params: {})
+        symbolize_response(authenticated_connection.get("#{full_url}/", params).body)
+      end
+
+      def get(id:)
+        symbolize_response(authenticated_connection.get("#{full_url}/#{id}").body)
+      end
+
+      def post(payload:, params: {})
+        symbolize_response(authenticated_connection.post(full_url_with_params(params: params), payload).body)
+      end
+
+      def put(id:, payload:, params: {})
+        symbolize_response(authenticated_connection.put(full_url_with_params(id: id, params: params), payload).body)
+      end
+    end
+  end
+end

data/lib/active_record_api/request/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecordApi
+  module Request
+    VERSION = '0.1.1'.freeze
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: active_record_api-request
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Full Measure Education
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby library for making requests to the services using the active_record_api-rest_controller
+  gem
+email:
+- devops@fullmeasureed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/active_record_api/request.rb
+- lib/active_record_api/request/connection.rb
+- lib/active_record_api/request/credentials.rb
+- lib/active_record_api/request/faraday_cache_service_down.rb
+- lib/active_record_api/request/faraday_follow_next_links.rb
+- lib/active_record_api/request/methods.rb
+- lib/active_record_api/request/version.rb
+homepage: https://gitlab.com/fullmeasure/public/gems/active_record_api-request
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: A ruby library for making requests to the services using the active_record_api-rest_controller
+  gem
+test_files: []