cistern 2.1.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5db3cc1e5afb1123c9118dffecb14ff09e856775
-  data.tar.gz: baecd5ac5ed70c005256852169d83cf378878f13
+  metadata.gz: 32675f1c34663bf47fbea19c1f56e009884b8851
+  data.tar.gz: bd418e9510d7dfde5bc563a0e8a3471b174c6a2a
 SHA512:
-  metadata.gz: 19a35e7fdc627b77faeaad765971c1bcb71674918209545b7d33adfa377be0dbb703ab3c38453c09074eea278064b824e86dc33cf8866cccf39c55c8de55ec5c
-  data.tar.gz: 14993c84e82145d7d81f357a98bd50fcb8a9f0f99df0210529e2d9a84164fe005839a1ec4d8f1043240d522ac2cc4d7c790a9f1ef22f756d66be92d71c8be059
+  metadata.gz: 4f5044d67c9c3195a7ea0ec3f50186c4746aba1dec07cb16e582dc92d5b35219e913b9eeaef651ea75f71e6fc143603216339179627a516975741ccbf0c26014
+  data.tar.gz: 9db86cbe754c36b2c3f07e33b1b44c01d1c10dc97a746a61dd59cc1f616dd7574477b09c3ef0af24a5d1c7c025ff8a6d7162591c81ab4679746b2a1223bef0c7

data/Gemfile

@@ -8,7 +8,7 @@ group :test do
   gem "guard-bundler", "~> 2.0", require: false
   gem "pry-nav"
   gem "rake"
-  gem "rspec", "~> 2.99"
+  gem "rspec", "~> 3.3"
   gem "redis-namespace", "~> 1.4", "< 1.5"
   gem "codeclimate-test-reporter", require: false
 end

data/README.md

@@ -9,6 +9,61 @@ Cistern helps you consistently build your API clients and faciliates building mo
 
 ## Usage
 
+### Custom Architecture
+
+By default a service's `Request`, `Collection`, and `Model` are all classes. In Cistern ~> 3.0, the default will be modules.
+
+You can modify your client's architecture to be forwards compatible by using `Cistern::Client.with`
+
+```ruby
+class Foo::Client
+  include Cistern::Client.with(interface: :module)
+end
+```
+
+Now request classes would look like:
+
+```ruby
+class Foo::GetBar
+  include Foo::Request
+
+  def real
+    "bar"
+  end
+end
+```
+
+Other options include `:collection`, `:request`, and `:model`.  This options define the name of module or class interface for the service component.
+
+If `Request` is to reserved for a model, then the `Request` component name can be remapped to `Prayer`
+
+For example:
+
+```ruby
+class Foo::Client
+  include Cistern::Client.with(request: "Prayer")
+end
+```
+
+allows a model named `Request` to exist
+
+```ruby
+class Foo::Request < Foo::Model
+  identity :jovi
+end
+```
+
+while living on a `Prayer`
+
+```ruby
+class Foo::GetBar < Foo::Prayer
+  def real
+    service.request.get("/wing")
+  end
+end
+```
+
+
 ### Service
 
 This represents the remote service that you are wrapping. If the service name is `foo` then a good name is `Foo::Client`.

data/lib/cistern/client.rb

@@ -10,79 +10,120 @@ module Cistern::Client
     end
   end
 
+  # custom include
+  def self.with(options={})
+    client_module = Module.new
+
+    custom_include = <<-EOS
+      def self.included(klass)
+        Cistern::Client.setup(klass, #{options.inspect})
+
+        super
+      end
+    EOS
+
+    client_module.class_eval(custom_include, __FILE__, __LINE__)
+
+    client_module
+  end
+
+  # vanilla include
   def self.included(klass)
+    self.setup(klass)
+
+    super
+  end
+
+  def self.setup(klass, options={})
+    request_class    = options[:request]    || "Request"
+    collection_class = options[:collection] || "Collection"
+    model_class      = options[:model]      || "Model"
+
+    interface = options[:interface] || :class
+    interface_callback = (:class == interface) ? :inherited : :included
+
+    unless klass.name
+      raise ArgumentError, "can't turn anonymous class into a Cistern service"
+    end
+
     klass.class_eval <<-EOS, __FILE__, __LINE__
-        module Collections
-          include Cistern::Client::Collections
+      module Collections
+        include ::Cistern::Client::Collections
 
-          def service
-    #{klass.name}
-          end
+        def service
+          #{klass.name}
         end
+      end
 
-        def self.service
-    #{klass.name}
-        end
+      def self.service
+        #{klass.name}
+      end
 
-        class Real
-          def initialize(options={})
-          end
+      class Real
+        def initialize(options={})
         end
+      end
 
-        class Mock
-          def initialize(options={})
-          end
+      class Mock
+        def initialize(options={})
         end
+      end
 
-        class Model
-          include Cistern::Model
+      #{interface} #{model_class}
+        def self.#{interface_callback}(klass)
+          service.models << klass
 
-          def self.inherited(klass)
-            service.models << klass
-          end
+          klass.send(:include, ::Cistern::Model)
+
+          super
+        end
 
-          def self.service
-    #{klass.name}
-          end
+        def self.service
+          #{klass.name}
         end
+      end
 
-        class Collection
-          include Cistern::Collection
+      #{interface} #{collection_class}
+        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)
+        def self.#{interface_callback}(klass)
+          klass.send(:extend, Cistern::Attributes::ClassMethods)
+          klass.send(:extend, Cistern::Collection::ClassMethods)
+          klass.send(:include, Cistern::Attributes::InstanceMethods)
 
-            service.collections << klass
-          end
+          service.collections << klass
 
-          def self.service
-    #{klass.name}
-          end
+          super
         end
 
-        class Request
-          include Cistern::Request
+        def self.service
+          #{klass.name}
+        end
+      end
 
-          def self.inherited(klass)
-            klass.extend(Cistern::Request::ClassMethods)
+      #{interface} #{request_class}
+        include ::Cistern::Request
 
-            service.requests << klass
-          end
+        def self.service
+          #{klass.name}
+        end
 
-          def self.service
-    #{klass.name}
-          end
+        def self.#{interface_callback}(klass)
+          klass.extend(::Cistern::Request::ClassMethods)
 
-          def _mock(*args)
-            mock(*args)
-          end
+          service.requests << klass
 
-          def _real(*args)
-            real(*args)
-          end
+          super
         end
+
+        def _mock(*args)
+          mock(*args)
+        end
+
+        def _real(*args)
+          real(*args)
+        end
+      end
     EOS
 
     klass.send(:extend, Cistern::Client::ClassMethods)
@@ -97,8 +138,6 @@ module Cistern::Client
     klass::Real.send(:include, klass::Collections)
     klass::Real.send(:extend, Cistern::WaitFor)
     klass::Real.timeout_error = klass::Timeout
-
-    super
   end
 
   module ClassMethods

data/lib/cistern/request.rb

@@ -1,5 +1,9 @@
 module Cistern::Request
   def self.service_request(service, klass, name)
+    unless klass.name
+      raise ArgumentError, "can't turn anonymous class into a Cistern request"
+    end
+
     service::Mock.module_eval <<-EOS, __FILE__, __LINE__
       def #{name}(*args)
         #{klass}.new(self)._mock(*args)

data/lib/cistern/version.rb

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

data/spec/client_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+RSpec.describe "client" do
+  context "with specific architecture" do
+    it "allows module-based interfaces" do
+      class ModuleClient
+        include Cistern::Client.with(interface: :module)
+      end
+
+      class ModuleClient::Shoot
+        include ModuleClient::Request
+
+        def real(mod)
+          mod % 9
+        end
+      end
+
+      class ModuleClient::Moon
+        include ModuleClient::Model
+
+        identity :on
+
+        def save
+          self.identity % 3
+        end
+      end
+
+      class ModuleClient::Moons
+        include ModuleClient::Collection
+
+        model ModuleClient::Moon
+
+      end
+
+      expect(
+        ModuleClient.new.shoot(12)
+      ).to eq(3)
+
+      expect(ModuleClient.collections).to contain_exactly(ModuleClient::Moons)
+      expect(ModuleClient.models).to      contain_exactly(ModuleClient::Moon)
+      expect(ModuleClient.requests).to    contain_exactly(ModuleClient::Shoot)
+
+      expect(
+        ModuleClient.new.moons.new(on: 5).save
+      ).to eq(2)
+    end
+
+    it "allows custom model interface" do
+      class AskClient
+        include Cistern::Client.with(model: "Ask", interface: :module)
+      end
+
+      class AskClient::Model
+        include AskClient::Ask
+
+        identity :id
+
+        def save
+          9 % identity
+        end
+      end
+
+      expect(
+        AskClient.new.model(id: 9).save
+      ).to eq(0)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -11,8 +11,6 @@ Bundler.require(:test)
 Cistern.deprecation_warnings = false
 
 RSpec.configure do |c|
-  c.treat_symbols_as_metadata_keys_with_true_values = true
-
   if Kernel.respond_to?(:caller_locations)
     require File.expand_path('../../lib/cistern/coverage', __FILE__)
   else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cistern
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Josh Lane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-29 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies: []
 description: API client framework extracted from Fog
 email:
@@ -50,6 +50,7 @@ files:
 - lib/cistern/timeout.rb
 - lib/cistern/version.rb
 - lib/cistern/wait_for.rb
+- spec/client_spec.rb
 - spec/collection_spec.rb
 - spec/dirty_spec.rb
 - spec/formatter_spec.rb
@@ -87,6 +88,7 @@ signing_key:
 specification_version: 4
 summary: API client framework
 test_files:
+- spec/client_spec.rb
 - spec/collection_spec.rb
 - spec/dirty_spec.rb
 - spec/formatter_spec.rb