fme-api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b028002ac211599ca5aa83c9ca26e00c1df483d2c487e70bcc4d32f1747dd435
+  data.tar.gz: 7a8f8b86d98d5072b94f2dde816468dab7dc4991244122fac13d6a82b5106f97
+SHA512:
+  metadata.gz: 42396b9c3187e47b55128502bdd6d0bbe30d2cd7fdba909518b6fce6fe9148742f4dd597de65d241c935501c060af0640ab706b90d5952e15532fda3a43b052e
+  data.tar.gz: 952813dc46e4a0eabe7ca03ffcdb0f5737608c11fcfcacdd344a5505ef11f29f7b90eeff27e97b3c912eb4f12edaaa6c5604f8fea635a28631e77e1cc40d00dd

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,28 @@
+# Fme::Api
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fme-api'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install fme-api
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,27 @@
+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    = 'Fme::Api'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/fme/api.rb

@@ -0,0 +1,11 @@
+require 'fme/api/version'
+require 'rails'
+module Fme
+  module Api
+
+  end
+end
+require 'fme/api/railtie'
+require 'fme/api/request'
+require 'fme/api/faraday_follow_next_links'
+require 'fme/api/faraday_cache_service_down'

data/lib/fme/api/faraday_cache_service_down.rb

@@ -0,0 +1,50 @@
+require 'faraday'
+
+module Fme
+  module Api
+    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)
+        @app.call(env) && return unless :get == env[:method]
+        make_get_request(env)
+      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?
+        Rails.logger.warn "responding to #{cache_key(env)} request from cache"
+        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/fme/api/faraday_follow_next_links.rb

@@ -0,0 +1,50 @@
+require 'faraday'
+module Fme
+  module Api
+    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)
+        @app.call(env) && return unless :get == env[:method]
+        perform_with_next_links(env, max_pages)
+      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/fme/api/railtie.rb

@@ -0,0 +1,6 @@
+module Fme
+  module Api
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/fme/api/request.rb

@@ -0,0 +1,57 @@
+require 'faraday'
+require 'active_attr'
+module Fme
+  module Api
+    class Request
+      include ActiveAttr::Model
+      attr_accessor :host, :jwt, :debug
+
+      def self.protocol
+        if Rails.env.development?
+          'http://'
+        else
+          'https://'
+        end
+      end
+
+      def http_cache_options
+        http_cache_options = {
+          shared_cache: false,
+          store: Rails.cache
+        }
+        if debug
+          http_cache_options[:logger] = Rails.logger
+        end
+        http_cache_options
+      end
+
+      def healthy?
+        connection.get(service_url('/okcomputer/all.json')).body.dig('default', 'success')
+      end
+
+      private
+
+      def connection
+        @connection ||= Faraday.new(url: "#{self.class.protocol}#{host}") do |builder|
+          setup_connection(builder)
+        end
+      end
+
+      def setup_connection(builder)
+        builder.options[:open_timeout] = 2
+        builder.options[:timeout] = 5
+        builder.authorization :Bearer, jwt
+        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, Rails.cache
+        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
+  end
+end

data/lib/fme/api/version.rb

@@ -0,0 +1,5 @@
+module Fme
+  module Api
+    VERSION = '0.1.1'
+  end
+end

data/lib/tasks/fme/api_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :fme_api do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,222 @@
+--- !ruby/object:Gem::Specification
+name: fme-api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- samuelbirk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+- !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: rspec-rails
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+description: An request resource for the Full Measure Education API
+email:
+- samuel.birk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/fme/api.rb
+- lib/fme/api/faraday_cache_service_down.rb
+- lib/fme/api/faraday_follow_next_links.rb
+- lib/fme/api/railtie.rb
+- lib/fme/api/request.rb
+- lib/fme/api/version.rb
+- lib/tasks/fme/api_tasks.rake
+homepage: https://gitlab.com/fullmeasure/public/gems/fme-api
+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.6
+signing_key: 
+specification_version: 4
+summary: An request resource for the Full Measure Education API
+test_files: []