unleash 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e17e0aeb7e67031de9d1088f574059c27e897f7a4d1e14106274f4b2aed5b14
-  data.tar.gz: c12cf65f061e004f8b040b4bffa09c1515d432d678ed8e12d4baabf5ef36ba5c
+  metadata.gz: a27b367d8f33a853c46e239a81c0366c8d07d335b3faf58049a63412bec87e26
+  data.tar.gz: a1cfc2279f3a5d8859e482beaecb11b39f65dff4f903bb62329e48e3bb718df8
 SHA512:
-  metadata.gz: d76a97471f879db4a8458f916833923e31e6ea2b671d5d9421122bf54275ca27183ee18b064eae61e7a406b268d6a4c58cdc8ac2b617f00d67dc7c2015c0ceff
-  data.tar.gz: ed965bd8bb3c3d561e7eb93a0c44f91f9186fddb7b2932da025bc571ffdf3a4d9691a41a112375df51a01f19a22b81c4c1b849eccf00ba6ed5baed45020c6393
+  metadata.gz: e34aca4b62e43363279be75caf42b61f545a0b459329ba919bf74bc3c38ed3f54392107e0a90ed55f6e0a5b49e4a80d336475ca383a2fc97a9c402af45eab39f
+  data.tar.gz: 25e28af7767bed78cc54f3dd0390b8e4ddc5f987f7ff432d8e740646524483f55f1ca994a3cf59d089322b71007cc8828c8ffbe131847821d88715e35faa9b8a

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Naming/PredicateName:
+  NameWhitelist:
+    - is_enabled?
+
+Metrics/LineLength:
+  Max: 120
+
+Style/RedundantSelf:
+  Enabled: false
+Style/PreferredHashMethods:
+  Enabled: false

data/README.md

@@ -12,7 +12,7 @@ Leverage the [Unleash Server](https://github.com/Unleash/unleash) for powerful f
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'unleash', '~> 0.1.1'
+gem 'unleash', '~> 0.1.3'
 ```
 
 And then execute:

data/lib/unleash.rb

@@ -12,6 +12,7 @@ module Unleash
 
   STRATEGIES = Unleash::Strategy.constants
     .select { |c| Unleash::Strategy.const_get(c).is_a? Class }
+    .select { |c| !['NotImplemented', 'Base'].include?(c.to_s) }
     .map { |c|
       lowered_c = c.to_s
       lowered_c[0] = lowered_c[0].downcase

data/lib/unleash/client.rb

@@ -16,6 +16,7 @@ module Unleash
       Unleash.logger.level = Unleash.configuration.log_level
 
       Unleash.toggle_fetcher = Unleash::ToggleFetcher.new
+      register
 
       unless Unleash.configuration.disable_metrics
         Unleash.toggle_metrics = Unleash::Metrics.new
@@ -25,7 +26,6 @@ module Unleash
           Unleash.reporter.send
         end
       end
-      register
     end
 
     def is_enabled?(feature, context = nil, default_value = false)
@@ -61,14 +61,23 @@ module Unleash
 
       uri = URI(Unleash.configuration.client_register_url)
       http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == 'https'
       http.open_timeout = Unleash.configuration.timeout # in seconds
       http.read_timeout = Unleash.configuration.timeout # in seconds
-      headers = {'Content-Type' => 'application/json'}
+
+      headers = (Unleash.configuration.custom_http_headers || {}).dup
+      headers['Content-Type'] = 'application/json'
+
       request = Net::HTTP::Post.new(uri.request_uri, headers)
       request.body = info.to_json
 
-      # Send the request
-      response = http.request(request)
+      # Send the request, if possible
+      begin
+        response = http.request(request)
+      rescue Exception => e
+        Unleash.logger.error "unable to register client with unleash server due to exception #{e.class}:'#{e}'."
+        Unleash.logger.error "stacktrace: #{e.backtrace}"
+      end
     end
   end
 end

data/lib/unleash/configuration.rb

@@ -4,6 +4,7 @@ require 'tmpdir'
 module Unleash
   class Configuration
     attr_accessor :url, :app_name, :instance_id,
+      :custom_http_headers,
       :disable_metrics, :timeout, :retry_limit,
       :refresh_interval, :metrics_interval,
       :backup_file, :logger, :log_level
@@ -13,6 +14,11 @@ module Unleash
       self.url           = opts[:url]         || nil
       self.instance_id   = opts[:instance_id] || SecureRandom.uuid
 
+      if opts[:custom_http_headers].is_a?(Hash) || opts[:custom_http_headers].nil?
+        self.custom_http_headers = opts[:custom_http_headers] || {}
+      else
+        raise ArgumentError, "custom_http_headers must be a hash."
+      end
       self.disable_metrics  = opts[:disable_metrics]  || false
       self.refresh_interval = opts[:refresh_interval] || 15
       self.metrics_interval = opts[:metrics_interval] || 10
@@ -42,7 +48,11 @@ module Unleash
 
     def validate!
       if self.app_name.nil? or self.url.nil?
-        raise ArgumentError, "URL and app_name are required"
+        raise ArgumentError, "URL and app_name are required parameters."
+      end
+
+      if ! self.custom_http_headers.is_a?(Hash)
+        raise ArgumentError, "custom_http_headers must be a hash."
       end
     end
 

data/lib/unleash/metrics_reporter.rb

@@ -40,9 +40,12 @@ module Unleash
 
       uri = URI(Unleash.configuration.client_metrics_url)
       http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == 'https'
       http.open_timeout = Unleash.configuration.timeout # in seconds
       http.read_timeout = Unleash.configuration.timeout # in seconds
-      headers = {'Content-Type' => 'application/json'}
+
+      headers = (Unleash.configuration.custom_http_headers || {}).dup
+      headers['Content-Type'] = 'application/json'
       request = Net::HTTP::Post.new(uri.request_uri, headers)
       request.body = generated_report.to_json
 
@@ -58,4 +61,4 @@ module Unleash
 
     end
   end
-end
+end

data/lib/unleash/scheduled_executor.rb

@@ -24,7 +24,8 @@ module Unleash
             self.retry_count = 0
           rescue Exception => e
             self.retry_count += 1
-            Unleash.logger.error "thread #{name} throwing exception (#{self.retry_count} of #{self.max_exceptions})", e
+            Unleash.logger.error "thread #{name} threw exception #{e.class}:'#{e}' (#{self.retry_count}/#{self.max_exceptions})"
+            Unleash.logger.error "stacktrace: #{e.backtrace}"
           end
 
           break if self.retry_count > self.max_exceptions
@@ -32,4 +33,4 @@ module Unleash
       end
     end
   end
-end
+end

data/lib/unleash/strategy/application_hostname.rb

@@ -14,7 +14,7 @@ module Unleash
       end
 
       # need: :params[:hostnames]
-      def is_enabled?(params = {}, context = nil)
+      def is_enabled?(params = {}, _context = nil)
         return false unless params.is_a?(Hash) && params.has_key?('hostnames')
 
         params['hostnames'].split(",").map(&:strip).map{|h| h.downcase }.include?(self.hostname)

data/lib/unleash/strategy/gradual_rollout_random.rb

@@ -8,7 +8,7 @@ module Unleash
       end
 
       # need: params['percentage']
-      def is_enabled?(params = {}, context = nil)
+      def is_enabled?(params = {}, _context = nil)
         return false unless params.is_a?(Hash) && params.has_key?('percentage')
 
         begin
@@ -17,9 +17,7 @@ module Unleash
           return false
         end
 
-        randomNumber = Random.rand(100) + 1
-
-        (percentage >= randomNumber)
+        (percentage >= Random.rand(1..100))
       end
     end
   end

data/lib/unleash/strategy/remote_address.rb

@@ -11,7 +11,7 @@ module Unleash
         return false unless params.fetch('ips', nil).is_a? String
         return false unless context.class.name == 'Unleash::Context'
 
-        params['ips'].split(',').map(&:strip).include?( context.remote_address )
+        params['ips'].split(',').map(&:strip).include?(context.remote_address)
       end
     end
   end

data/lib/unleash/toggle_fetcher.rb

@@ -22,7 +22,6 @@ module Unleash
       rescue Exception => e
         Unleash.logger.warn "ToggleFetcher was unable to fetch from the network, attempting to read from backup file."
         read!
-        raise e
       end
 
       # once we have initialized, start the fetcher loop
@@ -39,16 +38,22 @@ module Unleash
     end
 
     # rename to refresh_from_server!  ??
+    # TODO: should simplify by moving uri / http initialization to class initialization
     def fetch
       Unleash.logger.debug "fetch()"
       Unleash.logger.debug "ETag: #{self.etag}" unless self.etag.nil?
 
       uri = URI(Unleash.configuration.fetch_toggles_url)
       http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == 'https'
       http.open_timeout = Unleash.configuration.timeout # in seconds
       http.read_timeout = Unleash.configuration.timeout # in seconds
-      request = Net::HTTP::Get.new(uri.request_uri)
-      request['If-None-Match'] = self.etag unless self.etag.nil?
+
+      headers = (Unleash.configuration.custom_http_headers || {}).dup
+      headers['Content-Type'] = 'application/json'
+      headers['If-None-Match'] = self.etag unless self.etag.nil?
+
+      request = Net::HTTP::Get.new(uri.request_uri, headers)
 
       response = http.request(request)
 
@@ -110,7 +115,8 @@ module Unleash
         end
       rescue Exception => e
         # This is not really the end of the world. Swallowing the exception.
-        Unleash.logger.error "Unable to save backup file."
+        Unleash.logger.error "Unable to save backup file. Exception thrown #{e.class}:'#{e}'"
+        Unleash.logger.error "stacktrace: #{e.backtrace}"
       ensure
         file.close unless file.nil?
       end
@@ -129,16 +135,18 @@ module Unleash
 
         backup_as_hash = JSON.parse(line_cache)
         synchronize_with_local_cache!(backup_as_hash)
+        update_client!
 
       rescue IOError => e
         Unleash.logger.error "Unable to read the backup_file."
       rescue JSON::ParserError => e
         Unleash.logger.error "Unable to parse JSON from existing backup_file."
       rescue Exception => e
-        Unleash.logger.error "Unable to extract valid data from backup_file."
+        Unleash.logger.error "Unable to extract valid data from backup_file. Exception thrown #{e.class}:'#{e}'"
+        Unleash.logger.error "stacktrace: #{e.backtrace}"
       ensure
         file.close unless file.nil?
       end
     end
   end
-end
+end

data/lib/unleash/version.rb

@@ -1,3 +1,3 @@
 module Unleash
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/unleash-client.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
   spec.add_development_dependency "coveralls"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleash
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Renato Arruda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-03 00:00:00.000000000 Z
+date: 2018-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: murmurhash3
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +105,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -116,7 +131,6 @@ files:
 - lib/unleash/strategy/gradual_rollout_sessionid.rb
 - lib/unleash/strategy/gradual_rollout_userid.rb
 - lib/unleash/strategy/remote_address.rb
-- lib/unleash/strategy/unknown.rb
 - lib/unleash/strategy/user_with_id.rb
 - lib/unleash/strategy/util.rb
 - lib/unleash/toggle_fetcher.rb

data/lib/unleash/strategy/unknown.rb

@@ -1,13 +0,0 @@
-module Unleash
-  module Strategy
-    class Unknown < Base
-      def name
-        'unknown'
-      end
-
-      def is_enabled?(params = {})
-        false
-      end
-    end
-  end
-end