hipflag 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b18769b4735bce8450b1d48e4815d7f5f7987f7492a32b40fd93953cd6b5860a
+  data.tar.gz: ecc90db5da2ed8d47ea65174668312a49befdeefd4fb033db07358250f0da8f1
+SHA512:
+  metadata.gz: e5b902e6afbd6c385d157499b21d427243127c468ef44661943bfcce87ef63abe5bfda594fd907df4c986cd8018349489059c0f6a1e4cebe2e2f1849802c1677
+  data.tar.gz: caa46f5249e3aacf285d3c56929e517556dca4c22380f46948572608847a551556f3f39f1d8b015e60346714f67231b48ec7ce6a03dd321849801d1a3b278a0f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec_status
+.byebug_history
+Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'byebug', '~> 11.0'
+  gem 'pry', '~> 0.12'
+end
+
+group :test do
+  gem 'rspec', '~> 3.8'
+  gem 'webmock', '~> 3.5.1'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Hipflag
+
+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,168 @@
+# hipflag
+
+[![Build Status](https://travis-ci.org/hipflag/hipflag_ruby.svg?branch=master)](https://travis-ci.org/hipflag/hipflag_ruby)
+
+<img src="https://static.hipflag.com/images/logo.png" width="272" alt="Hipflag logo">
+
+This gem is a Ruby client for interacting with [Hipflag API](https://www.hipflag.com/docs).
+
+[Hipflag](https://www.hipflag.com) is a tool that allows to control and roll out new product features with flags. It offers a simple UI to enable/disable feature flags. It also let users to enable flags for a given percentage of users
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hipflag'
+```
+
+or install it yourself as:
+
+    $ gem install hipflag
+
+## Usage
+
+### Initializing a client
+
+The client can be configured globally:
+
+```ruby
+Hipflag.configure do |config|
+  config.public_key = '**************'
+  config.secret_key = '**************'
+end
+
+Hipflag::Client.new
+```
+
+or by instance:
+
+```ruby
+Hipflag::Client.new(public_key: '*******', secret_key: '*******')
+```
+
+### Client methods
+
+Clients methods returns a `Hipflag::Response` object. This kind of objects contain methods to get the status of the request (ie: `#ok?`, `#created?`, ...) and a method called `#json` which returns a JSON representation of the response.
+
+#### Flag
+##### #flag(flag_id)
+
+It returns relevant information about a specific flag
+
+```ruby
+client.flag('new-header').json
+```
+
+Response
+```ruby
+{
+  'flag' => {
+    'active' => true,
+    'name' => 'new-header'
+  }
+}
+```
+
+It is possible to pass a `user_id` to check if the flag is enabled for that given user:
+
+```ruby
+client.flag('new-header', user_id: 123).json
+```
+
+If a flag is not found, the client raises a `Hipflag::Client:NotFound` exception. Example:
+
+```ruby
+client.flag('unknown-flag')
+```
+
+Exception raised:
+```
+Hipflag::Client::NotFound: Resource not found
+```
+
+##### #update_flag(flag_id, params)
+
+This method updates a specific flag
+
+```ruby
+client.update_flag('new-header', rollout: 75).json
+```
+
+Response
+```ruby
+{
+  'flag' => {
+    'enabled' => true,
+    'rollout' => 75,
+    'name' => 'new-header'
+  }
+}
+```
+
+```ruby
+client.update_flag('new-header', enabled: false).json
+```
+
+Response
+```ruby
+{
+  'flag' => {
+    'enabled' => false,
+    'rollout' => 75,
+    'name' => 'new-header'
+  }
+}
+```
+
+If Hipflag cannot update a flag because a param is not valid, the client raises an exception including the error message. For example:
+
+```ruby
+client.update_flag('new-header', rollout: 500).json
+```
+
+Exception raised
+```
+Hipflag::Client::UnprocessableEntity: {"message"=>{"rollout"=>["must be less than or equal to 100"]}}
+```
+
+You can get the list of editable attributes in the [documentation](https://www.hipflag.com/docs).
+
+### Client errors
+
+`Hipflag::Client` methods can raise several exceptions when performing requests:
+
+* `Hipflag::Client::Unauthorized`: Request is not properly authenticated
+* `Hipflag::Client::ServerError`: Hipflag API is not responding
+* `Hipflag::Client::NotFound`: Resource is not found (`404`)
+* `Hipflag::Client::UnprocessableEntity`: Request could not be processed
+
+### How to retrieve the authentication keys
+
+You can get your personal `Public`and `Secret` keys at https://www.hipflag.com/users/me
+
+### How to using in Rails
+
+The best way to use the client in a Rails application is adding a initializer: `config/initializers/hipflag.rb`:
+
+```ruby
+Hipflag.configure do |config|
+  config.public_key = '**************'
+  config.secret_key = '**************'
+end
+```
+
+Then you can instantiate the client already containing the configuration:
+
+```ruby
+Hipflag::Client.new
+=> #<Hipflag::Client:0x00007faa173be430 @public_key="**********", @secret_key="**********">
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hipflag/hipflag_ruby. 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)

data/Rakefile

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

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+$stdout.sync = true
+
+require 'bundler/setup'
+require 'hipflag'
+require 'pry'
+
+ARGV.clear
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/hipflag.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hipflag/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'hipflag'
+  spec.version = Hipflag::VERSION
+  spec.authors = ['Hipflag']
+  spec.email = ['info@hipflag.com']
+
+  spec.summary = %q{Ruby client for interacting with Hipflag API}
+  spec.description = %q{This gem is a Ruby client for interacting with Hipflag API. Hipflag is a tool that allows to control and roll out new product features with flags}
+  spec.homepage = 'https://github.com/hipflag/hipflag_ruby'
+  spec.license = 'MIT'
+
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  end
+  spec.bindir = 'bin'
+  spec.executables  = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'patron', '~> 0.13.1'
+  spec.add_dependency 'oj', '~> 3.7.12'
+  spec.add_dependency 'zeitwerk', '~> 2.1.6'
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 12.3'
+end

data/lib/hipflag.rb

@@ -0,0 +1,11 @@
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem
+loader.enable_reloading
+loader.setup
+loader.reload
+
+module Hipflag
+  class << self
+    include Hipflag::Configurable
+  end
+end

data/lib/hipflag/client.rb

@@ -0,0 +1,58 @@
+require 'patron'
+
+module Hipflag
+  class Client
+    include Client::Flag
+
+    NotFound = Class.new(RuntimeError)
+    ServerError = Class.new(RuntimeError)
+    Unauthorized = Class.new(RuntimeError)
+    UnprocessableEntity = Class.new(RuntimeError)
+
+    BASE_URL = 'https://api.hipflag.com/v1/'
+    TIMEOUT = 10
+
+    attr_reader(*Configurable::OPTIONS)
+
+    def initialize(options = {})
+      Configurable::OPTIONS.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || Hipflag.send(key))
+      end
+
+      http_client.base_url = BASE_URL
+    end
+
+    private
+
+    def http_client
+      @http_client ||= Patron::Session.new do |config|
+        config.timeout = TIMEOUT
+        config.headers = {
+          'Content-Type' => 'application/json',
+          'X-Auth-Public' => @public_key,
+          'X-Auth-Secret' => @secret_key
+        }
+      end
+    end
+
+    def perform_request(method, url, params = {})
+      handle_errors do
+        Response.new(http_client.request(method, url, {}, params))
+      end
+    end
+
+    def handle_errors
+      yield.tap do |response|
+        if response.unauthorized?
+          raise Unauthorized, 'Unauthorized'
+        elsif response.unprocessable?
+          raise UnprocessableEntity, response.json
+        elsif response.server_error?
+          raise ServerError, 'Server is not available'
+        elsif response.not_found?
+          raise NotFound, 'Resource not found'
+        end
+      end
+    end
+  end
+end

data/lib/hipflag/client/flag.rb

@@ -0,0 +1,21 @@
+module Hipflag
+  class Client
+    module Flag
+      def flag(flag_id, user_id: nil)
+        perform_request(:get, "flags/#{flag_id}?#{flag_params(user_id)}")
+      end
+
+      def update_flag(flag_id, params)
+        perform_request(:put, "flags/#{flag_id}", data: { flag: params }.to_json)
+      end
+
+      private
+
+      def flag_params(user_id)
+        return if user_id.nil?
+
+        URI.encode_www_form(user_id: user_id)
+      end
+    end
+  end
+end

data/lib/hipflag/configurable.rb

@@ -0,0 +1,11 @@
+module Hipflag
+  module Configurable
+    OPTIONS = %i[public_key secret_key].freeze
+
+    attr_accessor(*OPTIONS)
+
+    def configure
+      yield self
+    end
+  end
+end

data/lib/hipflag/response.rb

@@ -0,0 +1,40 @@
+require 'delegate'
+require 'oj'
+
+module Hipflag
+  class Response < SimpleDelegator
+    alias_method :object, :__getobj__
+
+    def json
+      Oj.load(object.body)
+    end
+
+    def ok?
+      object.status == 200
+    end
+
+    def created?
+      object.status == 201
+    end
+
+    def no_content?
+      object.status == 204
+    end
+
+    def unauthorized?
+      object.status == 401
+    end
+
+    def not_found?
+      object.status == 404
+    end
+
+    def unprocessable?
+      object.status == 422
+    end
+
+    def server_error?
+      object.status >= 500
+    end
+  end
+end

data/lib/hipflag/version.rb

@@ -0,0 +1,3 @@
+module Hipflag
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: hipflag
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Hipflag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: patron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.12
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+description: This gem is a Ruby client for interacting with Hipflag API. Hipflag is
+  a tool that allows to control and roll out new product features with flags
+email:
+- info@hipflag.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hipflag.gemspec
+- lib/hipflag.rb
+- lib/hipflag/client.rb
+- lib/hipflag/client/flag.rb
+- lib/hipflag/configurable.rb
+- lib/hipflag/response.rb
+- lib/hipflag/version.rb
+homepage: https://github.com/hipflag/hipflag_ruby
+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.0.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for interacting with Hipflag API
+test_files: []