semian 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9df1d9d29629650b74dab6ead2cc8d288de28d78
-  data.tar.gz: 8752cce5af3858930ee820eab7c2f1c558eeed22
+  metadata.gz: 6d26f3db6e9a869dda06d6c9de1b6d450ce50659
+  data.tar.gz: 101fb40d19d110414db888954715e8dd2dfd9f22
 SHA512:
-  metadata.gz: 2070b61bb3ac7080c36eaba3c0508eb81928b32111dd11e6f5d9668b78fada81549f2eac75f3021787ce03fd30b6f3c5f01a4f5f99d077b0b3aa9aeecc5a3e9d
-  data.tar.gz: 63f9400b70e1bf039819bb26accf5ecbcea87ab1fb938ff0abaf8e44ccfbbd78e016c3ff48832960cab6fb1c9428785da0f4c2333d15c651b2647bf99d9ae41d
+  metadata.gz: c3ffb155d0b7e026944a0eee7dfa47983c42a88ae9dc0781729a27f7f8b34933f3fd257470ef30ee385c07c3746d7da1ac75170955cc7edfdf42a43e7e0d848d
+  data.tar.gz: 3264158b8d95db9d254d22093856eaeeaf9388941fc5f235606c038c548b8605cc24661f52a545c730745952c171f3770c30f4f7f41db101fb892d24f8a1d9c6

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.4.1
+* resource: cast float ticket count to fixnum #75
+
 # v0.4.0
 
 * net/http: add adapter for net/http #58

data/README.md

@@ -130,12 +130,13 @@ client = Redis.new(semian: {
 #### Net::HTTP
 For the `Net::HTTP` specific Semian adapter, since many external libraries may create
 HTTP connections on the user's behalf, the parameters are instead provided
-by calling specific functions in `Semian::NetHTTP`, perhaps in an initialization file.
+by associating callback functions with `Semian::NetHTTP`, perhaps in an initialization file.
 
 ##### Naming and Options
 To give Semian parameters, assign a `proc` to `Semian::NetHTTP.semian_configuration`
-that takes a two parameters, `host` and `port` like `127.0.0.1` and `80` or `github_com` and `80`,
-and returns a `Hash` with keys as follows.
+that takes a two parameters, `host` and `port` like `127.0.0.1`,`443` or `github_com`,`80`,
+and returns a `Hash` with configuration parameters as follows. The `proc` is used as a
+callback to initialize the configuration options, similar to other adapters.
 
 ```ruby
 SEMIAN_PARAMETERS = { tickets: 1,
@@ -161,6 +162,11 @@ The `semian_options` passed apply to that resource. Semian creates the `semian_i
 from the `name` to look up and store changes in the circuit breaker and bulkhead states
 and associate successes, failures, errors with the protected resource.
 
+We only require that:
+* the `semian_configuration` be **set only once** over the lifetime of the library
+* the output of the `proc` be the same over time, that is, the configuration produced by
+  each pair of `host`, `port` is **the same each time** the callback is invoked.
+
 For most purposes, `"#{host}_#{port}"` is a good default `name`. Custom `name` formats
 can be useful to grouping related subdomains as one resource, so that they all
 contribute to the same circuit breaker and bulkhead state and fail together.
@@ -560,7 +566,7 @@ non-IO.
 [redis-semian-adapter]: lib/semian/redis.rb
 [semian-adapter]: lib/semian/adapter.rb
 [nethttp-semian-adapter]: lib/semian/net_http.rb
-[nethttp-default-errors]: lib/semian/net_http.rb#L33-L43
+[nethttp-default-errors]: lib/semian/net_http.rb#L35-L45
 [semian-instrumentable]: lib/semian/instrumentable.rb
 [statsd-instrument]: http://github.com/shopify/statsd-instrument
 [resiliency-blog-post]: http://www.shopify.com/technology/16906928-building-and-testing-resilient-ruby-on-rails-applications

data/ext/semian/semian.c

@@ -283,6 +283,10 @@ semian_resource_initialize(VALUE self, VALUE id, VALUE tickets, VALUE permission
   if (TYPE(id) != T_SYMBOL && TYPE(id) != T_STRING) {
     rb_raise(rb_eTypeError, "id must be a symbol or string");
   }
+  if (TYPE(tickets) == T_FLOAT) {
+    rb_warn("semian ticket value %f is a float, converting to fixnum", RFLOAT_VALUE(tickets));
+    tickets = INT2FIX((int) RFLOAT_VALUE(tickets));
+  }
   Check_Type(tickets, T_FIXNUM);
   Check_Type(permissions, T_FIXNUM);
   if (TYPE(default_timeout) != T_FIXNUM && TYPE(default_timeout) != T_FLOAT) {

data/lib/semian/net_http.rb

@@ -22,12 +22,14 @@ module Semian
     ResourceBusyError = ::Net::ResourceBusyError
     CircuitOpenError = ::Net::CircuitOpenError
 
-    def semian_configuration
-      Semian::NetHTTP.retrieve_semian_configuration(address, port)
+    class SemianConfigurationChangedError < RuntimeError
+      def initialize(msg = "Cannot re-initialize semian_configuration")
+        super
+      end
     end
 
     def semian_identifier
-      "nethttp_#{semian_configuration[:name]}"
+      "nethttp_#{raw_semian_options[:name]}"
     end
 
     DEFAULT_ERRORS = [
@@ -52,8 +54,13 @@ module Semian
     end
 
     class << self
-      attr_accessor :semian_configuration
       attr_accessor :exceptions
+      attr_reader :semian_configuration
+
+      def semian_configuration=(configuration)
+        raise Semian::NetHTTP::SemianConfigurationChangedError unless @semian_configuration.nil?
+        @semian_configuration = configuration
+      end
 
       def retrieve_semian_configuration(host, port)
         @semian_configuration.call(host, port) if @semian_configuration.respond_to?(:call)
@@ -67,9 +74,10 @@ module Semian
     Semian::NetHTTP.reset_exceptions
 
     def raw_semian_options
-      options = semian_configuration
-      options = options.dup unless options.nil?
-      options
+      @raw_semian_options ||= begin
+        @raw_semian_options = Semian::NetHTTP.retrieve_semian_configuration(address, port)
+        @raw_semian_options = @raw_semian_options.dup unless @raw_semian_options.nil?
+      end
     end
 
     def resource_exceptions
@@ -77,7 +85,7 @@ module Semian
     end
 
     def disabled?
-      semian_configuration.nil?
+      raw_semian_options.nil?
     end
 
     def connect

data/lib/semian/unprotected_resource.rb

@@ -1,6 +1,6 @@
 module Semian
   # This class acts as a replacement for `ProtectedResource` when
-  # the semian configuration of an `Adatper` is missing or explicitly disabled
+  # the semian configuration of an `Adapter` is missing or explicitly disabled
   class UnprotectedResource
     attr_reader :name
 

data/lib/semian/version.rb

@@ -1,3 +1,3 @@
 module Semian
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

data/semian.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n")
   s.extensions = ['ext/semian/extconf.rb']
   s.add_development_dependency 'rake-compiler', '~> 0.9'
+  s.add_development_dependency 'rake', '< 11.0'
   s.add_development_dependency 'timecop'
   s.add_development_dependency 'mysql2'
   s.add_development_dependency 'redis'

data/test/net_http_test.rb

@@ -21,6 +21,7 @@ class TestNetHTTP < MiniTest::Unit::TestCase
     error_timeout: 10,
   }.freeze
   DEFAULT_SEMIAN_CONFIGURATION = proc do |host, port|
+    next nil if host == "127.0.0.1" && port == 8474 # disable if toxiproxy
     DEFAULT_SEMIAN_OPTIONS.merge(name: "#{host}_#{port}")
   end
 
@@ -191,6 +192,17 @@ class TestNetHTTP < MiniTest::Unit::TestCase
     end
   end
 
+  def test_custom_raw_semian_options_can_only_assign_once
+    semian_configuration_proc = proc do |host, port|
+      DEFAULT_SEMIAN_OPTIONS.merge(name: "#{host}_#{port}")
+    end
+    with_semian_configuration(semian_configuration_proc) do
+      assert_raises(Semian::NetHTTP::SemianConfigurationChangedError) do
+        Semian::NetHTTP.semian_configuration = semian_configuration_proc
+      end
+    end
+  end
+
   def test_custom_raw_semian_options_work_with_default_fallback
     with_server do
       semian_config = {}
@@ -230,7 +242,8 @@ class TestNetHTTP < MiniTest::Unit::TestCase
     semian_config["development"]["nethttp_default"] = DEFAULT_SEMIAN_OPTIONS
     sample_env = "development"
 
-    semian_configuration_proc = proc do
+    semian_configuration_proc = proc do |host, port|
+      next nil if host == "127.0.0.1" && port == 8474 # # disable if toxiproxy
       semian_identifier = "nethttp_default"
       semian_config[sample_env][semian_identifier].merge(name: "default")
     end
@@ -344,10 +357,31 @@ class TestNetHTTP < MiniTest::Unit::TestCase
 
   def with_semian_configuration(options = DEFAULT_SEMIAN_CONFIGURATION)
     orig_semian_options = Semian::NetHTTP.semian_configuration
+    Semian::NetHTTP.instance_variable_set(:@semian_configuration, nil)
+    mutated_objects = {}
+    Semian::NetHTTP.send(:alias_method, :orig_semian_resource, :semian_resource)
+    Semian::NetHTTP.send(:alias_method, :orig_raw_semian_options, :raw_semian_options)
+    Semian::NetHTTP.send(:define_method, :semian_resource) do
+      mutated_objects[self] = [@semian_resource, @raw_semian_options] unless mutated_objects.key?(self)
+      orig_semian_resource
+    end
+    Semian::NetHTTP.send(:define_method, :raw_semian_options) do
+      mutated_objects[self] = [@semian_resource, @raw_semian_options] unless mutated_objects.key?(self)
+      orig_raw_semian_options
+    end
+
     Semian::NetHTTP.semian_configuration = options
     yield
   ensure
+    Semian::NetHTTP.instance_variable_set(:@semian_configuration, nil)
     Semian::NetHTTP.semian_configuration = orig_semian_options
+    Semian::NetHTTP.send(:alias_method, :semian_resource, :orig_semian_resource)
+    Semian::NetHTTP.send(:alias_method, :raw_semian_options, :orig_raw_semian_options)
+    Semian::NetHTTP.send(:undef_method, :orig_semian_resource, :orig_raw_semian_options)
+    mutated_objects.each do |instance, (res, opt)| # Sadly, only way to fully restore cached properties
+      instance.instance_variable_set(:@semian_resource, res)
+      instance.instance_variable_set(:@raw_semian_options, opt)
+    end
   end
 
   def with_custom_errors(errors)

data/test/resource_test.rb

@@ -26,6 +26,12 @@ class TestResource < MiniTest::Unit::TestCase
     end
   end
 
+  def test_initialize_with_float
+    resource = create_resource :testing, tickets: 1.0
+    assert resource
+    assert_equal 1, resource.tickets
+  end
+
   def test_max_tickets
     assert Semian::MAX_TICKETS > 0
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semian
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Scott Francis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-26 00:00:00.000000000 Z
+date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -25,6 +25,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement