cistern 2.0.5 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 053c3db9a98499efb823bd487ba554ce44e672d2
-  data.tar.gz: 37dca3afb5dcfb97cfd2fa58bb4cdd7f3faeaf96
+  metadata.gz: 5db3cc1e5afb1123c9118dffecb14ff09e856775
+  data.tar.gz: baecd5ac5ed70c005256852169d83cf378878f13
 SHA512:
-  metadata.gz: 463d10527e74901c9536f5c41d45a0641750ab67d11aa8bcf1e9a2cc4045c41a4aef4336de3922ec6421738bc98fb91ef803c43833d5629c4aa1461f885db339
-  data.tar.gz: 44c09ffec87cefa480dcc3b6c15ce976760698dc2acafe9542de3d92fc0df0dc812fde890e36ad8f0c7bf9368a2f1f9192b8af6349eebac84baa562ef4185905
+  metadata.gz: 19a35e7fdc627b77faeaad765971c1bcb71674918209545b7d33adfa377be0dbb703ab3c38453c09074eea278064b824e86dc33cf8866cccf39c55c8de55ec5c
+  data.tar.gz: 14993c84e82145d7d81f357a98bd50fcb8a9f0f99df0210529e2d9a84164fe005839a1ec4d8f1043240d522ac2cc4d7c790a9f1ef22f756d66be92d71c8be059

data/README.md

@@ -16,7 +16,9 @@ This represents the remote service that you are wrapping. If the service name is
 Service initialization parameters are enumerated by `requires` and `recognizes`. Parameters defined using `recognizes` are optional.
 
 ```ruby
-class Foo::Client < Cistern::Service
+class Foo::Client
+  include Cistern::Client
+
   requires :hmac_id, :hmac_secret
   recognizes :url
 end
@@ -85,7 +87,7 @@ Foo::Client.new.respond_to?(:get_bars) # false
 Foo::Client.new.get_all_the_bars       # "all the bars"
 ```
 
-All declared requests can be listed via `Cistern::Service#requests`.
+All declared requests can be listed via `Cistern::Client#requests`.
 
 ```ruby
 Foo::Client.requests # => [Foo::Client::GetBars, Foo::Client::GetBar]
@@ -233,7 +235,9 @@ client.data.object_id        # 70199868378300
 You can make the service bypass Cistern's mock data structures by simply creating a `self.data` function in your service `Mock` declaration.
 
 ```ruby
-class Foo::Client < Cistern::Service
+class Foo::Client
+  include Cistern::Client
+
   class Mock
     def self.data
       @data ||= {}

data/lib/cistern/client.rb

@@ -0,0 +1,192 @@
+module Cistern::Client
+
+  module Collections
+    def collections
+      service.collections
+    end
+
+    def requests
+      service.requests
+    end
+  end
+
+  def self.included(klass)
+    klass.class_eval <<-EOS, __FILE__, __LINE__
+        module Collections
+          include Cistern::Client::Collections
+
+          def service
+    #{klass.name}
+          end
+        end
+
+        def self.service
+    #{klass.name}
+        end
+
+        class Real
+          def initialize(options={})
+          end
+        end
+
+        class Mock
+          def initialize(options={})
+          end
+        end
+
+        class Model
+          include Cistern::Model
+
+          def self.inherited(klass)
+            service.models << klass
+          end
+
+          def self.service
+    #{klass.name}
+          end
+        end
+
+        class Collection
+          include Cistern::Collection
+
+          def self.inherited(klass)
+            klass.send(:extend, Cistern::Attributes::ClassMethods)
+            klass.send(:extend, Cistern::Collection::ClassMethods)
+            klass.send(:include, Cistern::Attributes::InstanceMethods)
+
+            service.collections << klass
+          end
+
+          def self.service
+    #{klass.name}
+          end
+        end
+
+        class Request
+          include Cistern::Request
+
+          def self.inherited(klass)
+            klass.extend(Cistern::Request::ClassMethods)
+
+            service.requests << klass
+          end
+
+          def self.service
+    #{klass.name}
+          end
+
+          def _mock(*args)
+            mock(*args)
+          end
+
+          def _real(*args)
+            real(*args)
+          end
+        end
+    EOS
+
+    klass.send(:extend, Cistern::Client::ClassMethods)
+    klass.send(:const_set, :Timeout, Class.new(Cistern::Error))
+
+    klass::Mock.send(:include, klass::Collections)
+    klass::Mock.send(:extend, Cistern::WaitFor)
+    klass::Mock.timeout_error = klass::Timeout
+
+    klass::Mock.send(:extend, Cistern::Data)
+
+    klass::Real.send(:include, klass::Collections)
+    klass::Real.send(:extend, Cistern::WaitFor)
+    klass::Real.timeout_error = klass::Timeout
+
+    super
+  end
+
+  module ClassMethods
+
+    def mock!;    @mocking = true; end
+    def mocking?; @mocking; end
+    def unmock!;  @mocking = false; end
+
+    def collections
+      @collections ||= []
+    end
+
+    def models
+      @_models ||= []
+    end
+
+    def recognized_arguments
+      @_recognized_arguments ||= []
+    end
+
+    def required_arguments
+      @_required_arguments ||= []
+    end
+
+    def requests
+      @_requests ||= []
+    end
+
+    def requires(*args)
+      self.required_arguments.concat(args)
+    end
+
+    def recognizes(*args)
+      self.recognized_arguments.concat(args)
+    end
+
+    def validate_options(options={})
+      required_options = Cistern::Hash.slice(options, *required_arguments)
+
+      missing_required_options = required_arguments - required_options.keys
+
+      unless missing_required_options.empty?
+        raise "Missing required options: #{missing_required_options.inspect}"
+      end
+
+      unrecognized_options = options.keys - (required_arguments + recognized_arguments)
+
+      unless unrecognized_options.empty?
+        raise "Unrecognized options: #{unrecognized_options.inspect}"
+      end
+    end
+
+    def setup
+      return true if @_setup
+
+      requests.each do |klass|
+        name = klass.service_method ||
+          Cistern::String.camelize(Cistern::String.demodulize(klass.name))
+
+        Cistern::Request.service_request(self, klass, name)
+      end
+
+      collections.each do |klass|
+        name = klass.service_method ||
+          Cistern::String.underscore(klass.name.gsub("#{self.name}::", "").gsub("::", ""))
+
+        Cistern::Collection.service_collection(self, klass, name)
+      end
+
+      models.each do |klass|
+        name = klass.service_method ||
+          Cistern::String.underscore(klass.name.gsub("#{self.name}::", "").gsub("::", ""))
+
+        Cistern::Model.service_model(self, klass, name)
+      end
+
+      @_setup = true
+    end
+
+    def new(options={})
+      setup
+      validate_options(options)
+
+      self.const_get(self.mocking? ? :Mock : :Real).new(options)
+    end
+
+    def reset!
+      self.const_get(:Mock).reset!
+    end
+  end
+end

data/lib/cistern/service.rb

@@ -1,188 +1,9 @@
 class Cistern::Service
-
-  def self.mock!;    @mocking = true; end
-  def self.mocking?; @mocking; end
-  def self.unmock!;  @mocking = false; end
-
-  module Collections
-    def collections
-      service.collections
-    end
-
-    def requests
-      service.requests
-    end
-  end
-
-  class << self
-    def inherited(klass)
-      klass.class_eval <<-EOS, __FILE__, __LINE__
-        module Collections
-          include Cistern::Service::Collections
-
-          def service
-            #{klass.name}
-          end
-        end
-
-        def self.service
-          #{klass.name}
-        end
-
-        class Real
-          def initialize(options={})
-          end
-        end
-
-        class Mock
-          def initialize(options={})
-          end
-        end
-
-        class Model
-          include Cistern::Model
-
-          def self.inherited(klass)
-            service.models << klass
-          end
-
-          def self.service
-            #{klass.name}
-          end
-        end
-
-        class Collection
-          include Cistern::Collection
-
-          def self.inherited(klass)
-            klass.send(:extend, Cistern::Attributes::ClassMethods)
-            klass.send(:extend, Cistern::Collection::ClassMethods)
-            klass.send(:include, Cistern::Attributes::InstanceMethods)
-
-            service.collections << klass
-          end
-
-          def self.service
-            #{klass.name}
-          end
-        end
-
-        class Request
-          include Cistern::Request
-
-          def self.inherited(klass)
-            klass.extend(Cistern::Request::ClassMethods)
-
-            service.requests << klass
-          end
-
-          def self.service
-            #{klass.name}
-          end
-
-          def _mock(*args)
-            mock(*args)
-          end
-
-          def _real(*args)
-            real(*args)
-          end
-        end
-      EOS
-
-      klass.send(:const_set, :Timeout, Class.new(Cistern::Error))
-
-      klass::Mock.send(:include, klass::Collections)
-      klass::Mock.send(:extend, Cistern::WaitFor)
-      klass::Mock.timeout_error = klass::Timeout
-
-      klass::Mock.send(:extend, Cistern::Data)
-
-      klass::Real.send(:include, klass::Collections)
-      klass::Real.send(:extend, Cistern::WaitFor)
-      klass::Real.timeout_error = klass::Timeout
-    end
-
-    def collections
-      @collections ||= []
-    end
-
-    def models
-      @_models ||= []
-    end
-
-    def recognized_arguments
-      @_recognized_arguments ||= []
-    end
-
-    def required_arguments
-      @_required_arguments ||= []
-    end
-
-    def requests
-      @_requests ||= []
-    end
-
-    def requires(*args)
-      self.required_arguments.concat(args)
-    end
-
-    def recognizes(*args)
-      self.recognized_arguments.concat(args)
-    end
-
-    def validate_options(options={})
-      required_options = Cistern::Hash.slice(options, *required_arguments)
-
-      missing_required_options = required_arguments - required_options.keys
-
-      unless missing_required_options.empty?
-        raise "Missing required options: #{missing_required_options.inspect}"
-      end
-
-      unrecognized_options = options.keys - (required_arguments + recognized_arguments)
-
-      unless unrecognized_options.empty?
-        raise "Unrecognized options: #{unrecognized_options.inspect}"
-      end
-    end
-
-    def setup
-      return true if @_setup
-
-      requests.each do |klass|
-        name = klass.service_method ||
-          Cistern::String.camelize(Cistern::String.demodulize(klass.name))
-
-        Cistern::Request.service_request(self, klass, name)
-      end
-
-      collections.each do |klass|
-        name = klass.service_method ||
-          Cistern::String.underscore(klass.name.gsub("#{self.name}::", "").gsub("::", ""))
-
-        Cistern::Collection.service_collection(self, klass, name)
-      end
-
-      models.each do |klass|
-        name = klass.service_method ||
-          Cistern::String.underscore(klass.name.gsub("#{self.name}::", "").gsub("::", ""))
-
-        Cistern::Model.service_model(self, klass, name)
-      end
-
-      @_setup = true
-    end
-
-    def new(options={})
-      setup
-      validate_options(options)
-
-      self.const_get(self.mocking? ? :Mock : :Real).new(options)
-    end
-
-    def reset!
-      self.const_get(:Mock).reset!
-    end
+  def self.inherited(klass)
+    Cistern.deprecation(
+      %q{subclassing Cistern::Service is deprecated.  Please use `include Cistern::Client`},
+      caller[0],
+    )
+    klass.send(:include, Cistern::Client)
   end
 end

data/lib/cistern/version.rb

@@ -1,3 +1,3 @@
 module Cistern
-  VERSION = "2.0.5"
+  VERSION = "2.1.0"
 end

data/lib/cistern.rb

@@ -1,7 +1,7 @@
 require 'cistern/version'
 
+# stdlib
 require 'time'
-require 'set'
 
 module Cistern
 
@@ -16,6 +16,7 @@ module Cistern
   require 'cistern/collection'
   require 'cistern/model'
   require 'cistern/service'
+  require 'cistern/client'
   require 'cistern/singular'
   require 'cistern/request'
   require 'cistern/data'
@@ -31,6 +32,20 @@ module Cistern
   def self.formatter
     @formatter ||= Cistern::Formatter.default
   end
+
+  def self.deprecation_warnings?
+    @deprecation_warnings.nil? ? true : !!@deprecation_warnings
+  end
+
+  def self.deprecation_warnings=(status)
+    @deprecation_warnings = status
+  end
+
+  def self.deprecation(message, source=caller[1])
+    if deprecation_warnings?
+      STDERR.puts("#{message}. (#{source})")
+    end
+  end
 end
 
 Cistern.timeout       = 180 # 3 minutes

data/spec/model_spec.rb

@@ -38,7 +38,8 @@ describe "Cistern::Model" do
   end
 
   it "should set singular resource service method" do
-    class ModelService < Cistern::Service
+    class ModelService
+      include Cistern::Client
     end
 
     class ModelService::Jimbob < ModelService::Model
@@ -49,7 +50,8 @@ describe "Cistern::Model" do
   end
 
   it "should set specific singular resource service method" do
-    class SpecificModelService < Cistern::Service
+    class SpecificModelService
+      include Cistern::Client
     end
 
     class SpecificModelService::Jimbob < SpecificModelService::Model

data/spec/spec_helper.rb

@@ -8,6 +8,8 @@ Dir[File.expand_path("../{support,shared,matchers,fixtures}/*.rb", __FILE__)].ea
 
 Bundler.require(:test)
 
+Cistern.deprecation_warnings = false
+
 RSpec.configure do |c|
   c.treat_symbols_as_metadata_keys_with_true_values = true
 

data/spec/support/service.rb

@@ -1 +1 @@
-class Sample < Cistern::Service; end
+class Sample; include Cistern::Client; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cistern
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.1.0
 platform: ruby
 authors:
 - Josh Lane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-21 00:00:00.000000000 Z
+date: 2015-09-29 00:00:00.000000000 Z
 dependencies: []
 description: API client framework extracted from Fog
 email:
@@ -30,6 +30,7 @@ files:
 - cistern.gemspec
 - lib/cistern.rb
 - lib/cistern/attributes.rb
+- lib/cistern/client.rb
 - lib/cistern/collection.rb
 - lib/cistern/coverage.rb
 - lib/cistern/data.rb