safelylaunch 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ea7229e64502f350239eafb2a748a5180c7b2e6575b5dca259f25d89845024d
-  data.tar.gz: b004e8c7675d3082c3a095c7161f7e41596ef4f89f973baa9d402e8f0b969cee
+  metadata.gz: 561fc09f13e32437d193dd5c258958a354afb56b1aa655ea31a429563b2a823f
+  data.tar.gz: e13e8e848d7dbf3f8a938829c08422ce66a425076a766c351a81b8764bb9b750
 SHA512:
-  metadata.gz: 8bc1e13e435f9cf4658a1c6dc8482d5c9dad84b2b10fc1eb6fdf7ab2edda570bfe48c8e4410faa5edf51b116eb8fa4fef65e9a952e0d1d56911b2fb1add3c5fe
-  data.tar.gz: a73924816255fe27662720be0809edec4f7b18fff8f70c2381545d14fab03eea40f7146b3bf50eb134dcb3cc1cf1a223f584df45c8bfccac9458c1aa756b0427
+  metadata.gz: a5d41e4ecb547cbf302b5bebec2770cdc1bfe5fabe2fc190e8c5be832f030e4cb78cd2881a0a93b666ffc32b5fbd28276e19eacb6f467489589dab898909733f
+  data.tar.gz: 8175518512944ad55f438a04be3ed3453fa0e37b20df1ac7a4100c3cc100344f0a50ec0fbda515c1b61b89016f94f95f1e0f81925f0dbf8545f3d3795794d5b2

data/.rspec

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

data/Gemfile

@@ -4,3 +4,6 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in safelylaunch.gemspec
 gemspec
+
+gem 'vcr'
+gem 'webmock'

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    safelylaunch (0.1.0)
+      concurrent-ruby
+      faraday
+      faraday_middleware
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    concurrent-ruby (1.1.4)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    hashdiff (0.3.8)
+    multipart-post (2.0.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    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)
+    safe_yaml (1.0.4)
+    vcr (4.0.0)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  safelylaunch!
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -1,8 +1,6 @@
 # Safelylaunch
 
-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/safelylaunch`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ruby client for SafelyLaunch project
 
 ## Installation
 
@@ -22,7 +20,49 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Initialization
+First step: require client
+
+```ruby
+require 'safelylaunch'
+```
+
+After that you need to create connection object and use it as a client instance dependency:
+
+```ruby
+connection = Safelylaunch::HttpConnection.new(
+  api_token: 'your env token', # required
+  host: 'your project instance host', # optional, default 'TODO'
+  logger: Logger.new, # optional, default Logger.new
+  cache_time: 10 # optional, how long cache requests in seconds. If `nil` will disable cache. Default `nil`
+)
+
+client = Safelylaunch::Client.new(connection)
+```
+
+### Usage
+Now we support only bool toggles without any params
+
+```ruby
+client.enable?('toggle-key') # => bool value
+```
+
+### Testing
+You can use mock connection for easy testing. It will store all defined toggles in memory and use it in your code:
+
+```ruby
+connection = Safelylaunch::MockConnection.new(
+  toggles: {
+    'toggle-key' => true,
+    'disable-toggle-key' => false,
+  }
+  logger: Logger.new # optional, default Logger.new
+)
+
+client = Safelylaunch::Client.new(connection)
+client.enable?('toggle-key') # => true
+client.enable?('disable-toggle-key') # => false
+```
 
 ## Development
 
@@ -32,7 +72,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/safelylaunch. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/safelylaunch/ruby-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
 
@@ -40,4 +80,6 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Safelylaunch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/safelylaunch/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Safelylaunch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/safelylaunch/ruby-client/blob/master/CODE_OF_CONDUCT.md).
+
+## About SafelyLaunch

data/lib/safelylaunch.rb

@@ -1,4 +1,8 @@
 require "safelylaunch/version"
+require 'safelylaunch/http_connection'
+require 'safelylaunch/mock_connection'
+require 'safelylaunch/client'
+require 'safelylaunch/http_cache'
 
 module Safelylaunch
   # Your code goes here...

data/lib/safelylaunch/client.rb

@@ -0,0 +1,14 @@
+module Safelylaunch
+  class Client
+    attr_reader :connection, :faraday_connection
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def enable?(toggle_key)
+      response = connection.get(toggle_key)
+      response[:enable]
+    end
+  end
+end

data/lib/safelylaunch/http_cache.rb

@@ -0,0 +1,32 @@
+require 'concurrent/map'
+
+module Safelylaunch
+  class HttpCache
+    Value = Struct.new(:expired_time, :data)
+
+    def initialize
+      @hash = Concurrent::Map.new
+    end
+
+    def put(key, payload, expired_in)
+      @hash.put_if_absent(key, Value.new(Time.new.to_i + expired_in, payload))
+      payload
+    end
+
+    def get(key)
+      value = @hash[key]
+
+      if value && (Time.new.to_i < value.expired_time)
+        value.data 
+      else
+        @hash.delete(key)
+        nil
+      end
+    end
+
+    # only for tests
+    def keys
+      @hash.keys
+    end
+  end
+end

data/lib/safelylaunch/http_connection.rb

@@ -0,0 +1,40 @@
+require 'logger'
+require 'faraday'
+require 'faraday_middleware'
+
+module Safelylaunch
+  class HttpConnection
+    attr_reader :api_token, :logger, :host, :connection, :cache_time
+
+    def initialize(api_token:, logger: Logger.new(STDOUT), cache_time: nil, host: 'http://localhost:2300')
+      @api_token = api_token
+      @logger = logger
+      @host = host
+      @cache_time = cache_time
+
+      @cache = HttpCache.new
+
+      @connection = Faraday.new(url: host, request: { timeout: 10 }) do |conn|
+        conn.response :json, content_type: %r{application/json}, parser_options: { symbolize_names: true }
+        conn.response :logger, logger
+
+        conn.adapter  Faraday.default_adapter
+      end
+    end
+
+    def get(key)
+      cache_time ? cached_check_toggle(key) : check_toggle(key)
+    end
+
+  private
+
+    def cached_check_toggle(key)
+      @cache.get(key) || @cache.put(key, check_toggle(key), cache_time)
+    end
+
+    def check_toggle(key)
+      response = connection.get('/api/v1/check', token: api_token, key: key)
+      response.body
+    end
+  end
+end

data/lib/safelylaunch/mock_connection.rb

@@ -0,0 +1,18 @@
+module Safelylaunch
+  class MockConnection
+    attr_reader :api_token, :logger, :host, :connection
+
+    def initialize(api_token:, toggles: {}, logger: Logger.new(STDOUT), host: 'http://localhost:2300')
+      @api_token = api_token
+      @logger = logger
+      @host = host
+      @connection = nil
+      @toggles = toggles
+    end
+
+    def get(key)
+      result = @toggles.fetch(key, false)
+      { key: key, enable: result }
+    end
+  end
+end

data/lib/safelylaunch/version.rb

@@ -1,3 +1,3 @@
 module Safelylaunch
-  VERSION = "0.0.0"
+  VERSION = "0.1.0"
 end

data/safelylaunch.gemspec

@@ -21,6 +21,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "concurrent-ruby"
+
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: safelylaunch
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Anton Davydov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-15 00:00:00.000000000 Z
+date: 2019-01-17 00:00:00.000000000 Z
 dependencies:
+- !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_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: concurrent-ruby
+  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
@@ -64,12 +106,17 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/safelylaunch.rb
+- lib/safelylaunch/client.rb
+- lib/safelylaunch/http_cache.rb
+- lib/safelylaunch/http_connection.rb
+- lib/safelylaunch/mock_connection.rb
 - lib/safelylaunch/version.rb
 - safelylaunch.gemspec
 homepage: https://github.com/safelylaunch/ruby-client