feature_flag_client 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15d0f87f4b7f35e40dc810108972fdad0d5a5c269c0df54efd2702828e226487
+  data.tar.gz: 690edf715a654e06bbc70bec36e93b53bf7514fffbe7c09dc1ff59837d7a6b1a
+SHA512:
+  metadata.gz: c9befad151fd62cffa052fc12a2a408edef28ebaf52837bda25c876e8202c0c453f5dbd3930203b7eb133c03f31abc9dfefd3cabdcade9cb1111c3da1aff5452
+  data.tar.gz: ae4ab58b011a62012c78b8654a387789bc9e109675614782f844f558c4cf402e9212d3d5c3cab6e7266449d55de5a0b99be24262fd1862496b49ad8b74f6f99e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  NewCops: enable
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.5
+before_install: gem install bundler -v 1.17.1

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.2.0
+
+* Major refactor
+* Introducing `Session`, `Configuration` classes

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ardeshir.eshghi@fundingcircle.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in feature_flag_client.gemspec
+gemspec
+
+gem 'rubocop', '~> 0.91.0'
+
+gem 'webmock', '~> 3.9'

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    feature_flag_client (0.1.0)
+      httparty (~> 0.17.3)
+      mini_cache (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    crack (0.4.4)
+    diff-lcs (1.3)
+    hashdiff (1.0.1)
+    httparty (0.17.3)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    mini_cache (1.1.0)
+    multi_xml (0.6.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (10.4.2)
+    regexp_parser (1.8.0)
+    rexml (3.2.4)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.91.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.4.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.4.2)
+      parser (>= 2.7.1.4)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+    webmock (3.9.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  feature_flag_client!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.91.0)
+  webmock (~> 3.9)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ardeshir Eshghi
+
+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,43 @@
+# Feature::Flag::Client
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/feature/flag/client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'feature-flag-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install feature-flag-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/feature-flag-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Feature::Flag::Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/feature-flag-client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'feature/flag/client'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/feature_flag_client.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'feature_flag_client/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'feature_flag_client'
+  spec.version       = FeatureFlagClient::Version::VERSION
+  spec.authors       = ['Ardeshir Eshghi']
+  spec.email         = ['ardeshir.eshghi@fundingcircle.com']
+  spec.required_ruby_version = '~> 2.4'
+
+  spec.summary       = 'Write a short summary, because RubyGems requires one.'
+  spec.description   = 'Write a longer description or delete this line.'
+  spec.homepage      = 'https://github.com/ardeshireshghi/feature-flag-clients/lib/clients/ruby'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/ardeshireshghi/feature-flag-clients/lib/clients/ruby'
+    spec.metadata['changelog_uri'] = 'https://github.com/ardeshireshghi/feature-flag-clients/lib/clients/ruby/feature-flag-client/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty', '~> 0.17.3'
+  spec.add_dependency 'mini_cache', '~> 1.1'
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.9'
+end

data/lib/feature_flag_client/client/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module FeatureFlagClient
+  module Version
+    VERSION = '0.2.0'
+  end
+end

data/lib/feature_flag_client/client.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'mini_cache'
+require 'json'
+
+require_relative './client/version'
+
+module FeatureFlagClient
+  class ClientError < StandardError; end
+
+  # Featureflag service Client configuration to set client details
+  class Configuration
+    attr_accessor :client_id, :client_secret, :api_base_url, :auth_url, :api_session
+  end
+
+  # Api response wrapper
+  class Response
+    def self.from_raw(raw_response)
+      new(raw_response)
+    end
+
+    def initialize(raw_response)
+      @body = raw_response.body
+      @code = raw_response.code
+    end
+
+    def parsed
+      @parsed ||= parse_response
+    end
+
+    def ok?
+      @code >= 200 && @code < 400
+    end
+
+    def error
+      case @code
+      when 401...505
+        parsed = JSON.parse(@body)
+        parsed.key?('message') ? parsed['message'] : parsed['error']
+      end
+    end
+
+    private
+
+    def parse_response
+      hash_response = JSON.parse(@body)
+      hash_response.each_with_object({}) do |item, result|
+        name, attributes = item
+        result[name] = OpenStruct.new(attributes)
+      end
+    end
+  end
+
+  # Api Client class to fetch the features
+  class Client
+    include FeatureFlagClient::Version
+
+    CACHE_KEY = 'features'
+    CACHE_TTL = 3600
+
+    def self.config
+      @config ||= FeatureFlagClient::Configuration.new
+    end
+
+    def self.configure
+      yield(config) if block_given?
+    end
+
+    def self.api_session
+      @api_session ||= Session.new(client_id: config.client_id, client_secret: config.client_secret) do |s|
+        s.auth_service_url = config.auth_url
+      end
+    end
+
+    def initialize
+      validate_config
+    end
+
+    def features(product_name)
+      if cache.get("#{CACHE_KEY}_#{product_name}").nil?
+        url = "#{config.api_base_url}#{features_pathname}"
+        response = Response.from_raw(perform_request_with_query(url, productName: product_name))
+
+        raise ClientError, response.error unless response.ok?
+
+        cache.set("#{CACHE_KEY}_#{product_name}", response.parsed, expires_in: CACHE_TTL)
+      end
+
+      cache.get("#{CACHE_KEY}_#{product_name}")
+    end
+
+    def version
+      VERSION
+    end
+
+    def cache
+      @cache ||= MiniCache::Store.new
+    end
+
+    def api_session
+      config.api_session || self.class.api_session
+    end
+
+    private
+
+    def config
+      self.class.config
+    end
+
+    def features_pathname
+      '/features'
+    end
+
+    def validate_config
+      raise ClientError, "'api_base_url' is not set" unless config.api_base_url
+
+      %w[auth_url client_id client_secret].each do |config_key|
+        raise ClientError, "'#{config_key}' is not set" if config.send(config_key).nil? && config.api_session.nil?
+      end
+    end
+
+    def perform_request_with_query(url, query)
+      HTTParty.get(url, {
+                     query: query,
+                     headers: {
+                       'Authorization' => "Bearer #{api_session.access_token}"
+                     }
+                   })
+    end
+  end
+end

data/lib/feature_flag_client/session.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module FeatureFlagClient
+  # Takes care of getting access_token necessary to call features service
+  class Session
+    attr_accessor :client_id, :client_secret, :auth_service_url
+
+    def initialize(client_id:, client_secret:)
+      @client_id = client_id
+      @client_secret = client_secret
+      yield(self) if block_given?
+    end
+
+    def access_token
+      @token ||= request_access_token
+      @token = request_access_token(refresh: true) if token_expired?
+      @token
+    end
+
+    def refresh_token
+      access_token if @parsed_auth_response.nil?
+      @parsed_auth_response['refresh_token']
+    end
+
+    private
+
+    def request_access_token(refresh: false)
+      raise StandardError, 'auth_service_url must be defined' if auth_service_url.nil?
+
+      auth_service_response_raw = HTTParty.post(auth_service_url, {
+                                                  body: auth_params(refresh: refresh).to_json,
+                                                  headers: {
+                                                    'Content-Type' => 'application/json'
+                                                  }
+                                                })
+
+      @parsed_auth_response = JSON.parse(auth_service_response_raw.body)
+      @parsed_auth_response['access_token']
+    end
+
+    def token_expired?
+      Time.now > Time.at(Time.now.to_i + @parsed_auth_response['expires_in'])
+    end
+
+    def auth_params(refresh: false)
+      params = {
+        client_id: client_id,
+        client_secret: client_secret
+      }
+
+      return params unless refresh
+
+      params.merge(refresh_token: @parsed_auth_response['refresh_token'])
+    end
+  end
+end

data/lib/feature_flag_client.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'feature_flag_client/session'
+require 'feature_flag_client/client'

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: feature_flag_client
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ardeshir Eshghi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+- !ruby/object:Gem::Dependency
+  name: mini_cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !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: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: Write a longer description or delete this line.
+email:
+- ardeshir.eshghi@fundingcircle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- feature_flag_client.gemspec
+- lib/feature_flag_client.rb
+- lib/feature_flag_client/client.rb
+- lib/feature_flag_client/client/version.rb
+- lib/feature_flag_client/session.rb
+homepage: https://github.com/ardeshireshghi/feature-flag-clients/lib/clients/ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ardeshireshghi/feature-flag-clients/lib/clients/ruby
+  source_code_uri: https://github.com/ardeshireshghi/feature-flag-clients/lib/clients/ruby
+  changelog_uri: https://github.com/ardeshireshghi/feature-flag-clients/lib/clients/ruby/feature-flag-client/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.4'
+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: Write a short summary, because RubyGems requires one.
+test_files: []