cistern 0.11.3 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a7f9a02401d9c9e5c38402adb3ed56d8abbf143
-  data.tar.gz: 3244f949b14837163187b45dae902531f60af58a
+  metadata.gz: 596a794e4f9c5986b6d3163405445f2712df6152
+  data.tar.gz: 7e49adeffc52e77885f8ab6dd4b409b0591d5bc4
 SHA512:
-  metadata.gz: 4ae10e49af345b7879c1b2f5ec8a88edfc2e18cc773a81e9b30205cd957c39ef404a606f1cc0344e9251fce2a6656df1d4f972a715ba45f8885aca3e62e9e809
-  data.tar.gz: 77df65c3624f3512296491173ab6bcd9b150f3b2bafff6169063b5e7f182ef607dbc0e56500d4d82cd324d68eaa65041b1e9643da28db3f338533fffe4fe840c
+  metadata.gz: 9046ac54d8b3c92b9665431dd56651e4f5985c1512bba516395ac3910ae14b1806ea1a1d1cb0fb762abd1f70c010863fdaae405c258486653f9719597786565e
+  data.tar.gz: a46cf7e5877fb598f0b37525f7feb451f0fa8a730a8ecaba605b924d6f1a3aa96e874d5e91bcb893a7941d8e142b2ec3082a9a17603388debb238574ff1f96b7

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

@@ -58,6 +58,29 @@ All declared requests can be listed via `Cistern::Service#requests`.
 Foo::Client.requests # => [:get_bar, :get_bars]
 ```
 
+##### Forward Compatible
+
+Ish.
+
+```ruby
+# client/requests/get_bar.rb
+class Foo:Client::GetBar
+
+  service Foo::Client
+
+  def real(bar_id)
+    connection.request("http://example.org/bar/#{bar_id}")
+  end
+
+  def mock
+    # do some mock things
+  end
+end
+```
+
+In this context, `connection` is reference to the `Cistern::Service`.
+
+
 #### Models and Collections
 
 Models and collections have declaration semantics similar to requests.  Models and collections are enumerated via `model` and `collection` respectively.

data/lib/cistern/formatter/default.rb

@@ -0,0 +1,22 @@
+module Cistern::Formatter::Default
+  class << self
+    def call(object)
+      case object
+      when Cistern::Collection
+        format_collection(object)
+      when Cistern::Model
+        format_model(object)
+      else
+        object.to_s
+      end
+    end
+
+    def format_model(model)
+      "#{model.to_s} #{model.attributes.inspect}"
+    end
+
+    def format_collection(collection)
+      "#{collection.to_s} #{collection.attributes.inspect} records=[#{collection.records.map { |m| format_model(m) }.join(", ")}]"
+    end
+  end
+end

data/lib/cistern/formatter.rb

@@ -7,6 +7,10 @@ module Cistern::Formatter
       Cistern::Formatter::AwesomePrint
     elsif defined?(::Formatador)
       Cistern::Formatter::Formatador
+    else
+      Cistern::Formatter::Default
     end
   end
 end
+
+require 'cistern/formatter/default'

data/lib/cistern/model.rb

@@ -5,11 +5,7 @@ class Cistern::Model
   attr_accessor :collection, :connection
 
   def inspect
-    if Cistern.formatter
-      Cistern.formatter.call(self)
-    else
-      "#<#{self.class} #{self.identity}"
-    end
+    Cistern.formatter.call(self)
   end
 
   def initialize(attributes={})

data/lib/cistern/request.rb

@@ -0,0 +1,41 @@
+class Cistern::Request
+  def self.register(service, klass, method)
+    service.requests << [method, {class: klass, method: method, new: true}]
+  end
+
+  def self.service(klass, options={})
+    @service = klass
+    @service_method = options[:method] || Cistern::String.underscore(
+      Cistern::String.demodulize(self.name)
+    )
+    Cistern::Request.register(klass, self, @service_method)
+  end
+
+  def self.service_method
+    @service_method
+  end
+
+  attr_reader :connection
+
+  alias service connection
+
+  def initialize(connection)
+    @connection = connection
+  end
+
+  def _real(*args, &block)
+    real(*args, &block)
+  end
+
+  def _mock(*args, &block)
+    mock(*args, &block)
+  end
+
+  def real(*args, &block)
+    raise NotImplementedError
+  end
+
+  def mock(*args, &block)
+    Cistern::Mock.not_implemented(self.class.service_method)
+  end
+end

data/lib/cistern/service.rb

@@ -163,11 +163,34 @@ class Cistern::Service
 
         # setup requests
         requests.each do |request, options|
-          unless options[:require] == false || service::Real.method_defined?(request.to_s)
+          unless (options[:require] == false) || options[:new] || service::Real.method_defined?(request.to_s)
             require(options[:require] || File.join(@request_path, request.to_s))
           end
 
-          if service::Mock.method_defined?(request)
+          if options[:new]
+            klass  = options.fetch(:class)
+            method = options.fetch(:method)
+
+            unless klass.instance_methods.include?(:mock)
+              klass.class_eval <<-EOS, __FILE__, __LINE__
+                def #{method}(*args)
+                  Cistern::Mock.not_implemented(request)
+                end
+              EOS
+            end
+
+            service::Real.module_eval <<-EOS, __FILE__, __LINE__
+              def #{method}(*args)
+                #{klass}.new(self)._real(*args)
+              end
+            EOS
+
+            service::Mock.module_eval <<-EOS, __FILE__, __LINE__
+              def #{method}(*args)
+                #{klass}.new(self)._mock(*args)
+              end
+            EOS
+          elsif service::Mock.method_defined?(request)
             mocked_requests << request
           else
             service::Mock.module_eval <<-EOS, __FILE__, __LINE__
@@ -180,11 +203,13 @@ class Cistern::Service
 
         # setup collections
         collections.each do |collection, options|
-          unless options[:require] == false
+          unless false == options[:require]
             require(options[:require] || File.join(@collection_path || @model_path, collection.to_s))
           end
 
-          class_name = collection.to_s.split("/").map(&:capitalize).join("::").split("_").map { |s| "#{s[0].upcase}#{s[1..-1]}" }.join
+          class_name = collection.to_s.
+            split("/").map(&:capitalize).join("::").split("_").
+            map { |s| "#{s[0].upcase}#{s[1..-1]}" }.join
           plural_name = options[:collection] || collection.to_s.gsub("/", "_")
 
           self.const_get(:Collections).module_eval <<-EOS, __FILE__, __LINE__

data/lib/cistern/string.rb

@@ -0,0 +1,23 @@
+class Cistern::String
+  # stolen from activesupport/lib/active_support/inflector/methods.rb, line 198
+  def self.demodulize(path)
+    path = path.to_s
+    if i = path.rindex('::')
+      path[(i+2)..-1]
+    else
+      path
+    end
+  end
+
+  # stolen from activesupport/lib/active_support/inflector/methods.rb, line 90
+  def self.underscore(camel_cased_word)
+    return camel_cased_word unless camel_cased_word =~ /[A-Z-]|::/
+    word = camel_cased_word.to_s.gsub(/::/, '/')
+    #word.gsub!(/(?:(?<=([A-Za-z\d]))|\b)(#{inflections.acronym_regex})(?=\b|[^a-z])/) { "#{$1 && '_'}#{$2.downcase}" }
+    word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    word
+  end
+end

data/lib/cistern/version.rb

@@ -1,3 +1,3 @@
 module Cistern
-  VERSION = "0.11.3"
+  VERSION = "0.12.1"
 end

data/lib/cistern.rb

@@ -19,6 +19,8 @@ module Cistern
   require 'cistern/data'
   require 'cistern/data/hash'
   require 'cistern/data/redis'
+  require 'cistern/request'
+  require 'cistern/string'
 
   extend WaitFor
 

data/spec/formatter_spec.rb

@@ -1,42 +1,75 @@
 require 'spec_helper'
 
-describe "#inspect" do
-  class Inspector < Cistern::Model
-    identity :id
-    attribute :name
+class Inspector < Cistern::Model
+  identity :id
+  attribute :name
+end
+
+class Anon < Cistern::Model
+  attribute :chan
+end
+
+class Inspectors < Cistern::Collection
+  model Inspector
+
+  def all(options={})
+    merge_attributes(options)
+    self.load([{id: 1, name: "2"},{id: 3, name: "4"}])
   end
+end
 
-  class Inspectors < Cistern::Collection
+describe Cistern::Formatter::Default do
+  before { Cistern.formatter = described_class }
 
-    model Inspector
+  it "formats a model" do
+    expect(
+      Inspector.new(id: 1, name: "name").inspect
+    ).to match(
+      /<Inspector:0x[a-z0-9]+> {:id=>1, :name=>\"name\"}/
+    )
 
-    def all(options={})
-      merge_attributes(options)
-      self.load([{id: 1, name: "2"},{id: 3, name: "4"}])
-    end
+    Anon.inspect
   end
 
-  describe "Cistern::Model" do
-    it "should use awesome_print" do
-      Cistern.formatter = Cistern::Formatter::AwesomePrint
+  it "formats a collection" do
+    expect(
+      Inspectors.new.all.inspect
+    ).to match(
+      /<Inspectors:0x[a-z0-9]+> {} records/
+    )
+  end
+end
 
-      Inspector.new(id: 1, name: "name").inspect.match /(?x-mi:\#<Inspector:0x[0-9a-f]+>\ {\n\ \ \ \ \ \ :id\x1B\[0;37m\ =>\ \x1B\[0m\x1B\[1;34m1\x1B\[0m,\n\ \ \ \ :name\x1B\[0;37m\ =>\ \x1B\[0m\x1B\[0;33m"name"\x1B\[0m\n})/
-    end
+describe Cistern::Formatter::AwesomePrint do
+  before { Cistern.formatter = described_class }
 
-    it "should use formatador" do
-      Cistern.formatter = Cistern::Formatter::Formatador
+  it "formats a model" do
+    expect(
+      Inspector.new(id: 1, name: "name").inspect
+    ).to match(
+      /(?x-mi:\#<Inspector:0x[0-9a-f]+>\ {\n\ \ \ \ \ \ :id\x1B\[0;37m\ =>\ \x1B\[0m\x1B\[1;34m1\x1B\[0m,\n\ \ \ \ :name\x1B\[0;37m\ =>\ \x1B\[0m\x1B\[0;33m"name"\x1B\[0m\n})/
+    )
+  end
+
+  it "formats a collection" do
+    expect(Inspectors.new.all.inspect).to match(/Inspectors\s+{.*}$/m) # close enough
+  end
+end
 
-      expect(Inspector.new(id: 1, name: "name").inspect).to eq(%q{  <Inspector
+describe Cistern::Formatter::Formatador do
+  before { Cistern.formatter = described_class }
+
+  it "formats a model" do
+    Cistern.formatter = Cistern::Formatter::Formatador
+
+    expect(Inspector.new(id: 1, name: "name").inspect).to eq(%q{  <Inspector
     id=1,
     name="name"
   >})
-    end
   end
 
-  describe "Cistern::Collection" do
-    it "should use formatador" do
-      Cistern.formatter = Cistern::Formatter::Formatador
-      expect(Inspectors.new.all.inspect).to eq(%q{  <Inspectors
+  it "formats a collection" do
+    expect(Inspectors.new.all.inspect).to eq(%q{  <Inspectors
     [
       <Inspector
         id=1,
@@ -48,11 +81,5 @@ describe "#inspect" do
       >
     ]
   >})
-    end
-
-    it "should use awesome_print" do
-      Cistern.formatter = Cistern::Formatter::AwesomePrint
-      expect(Inspectors.new.all.inspect).to match(/Inspectors\s+{.*}$/m) # close enough
-    end
   end
 end

data/spec/request_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Cistern do
+  class SampleService < Cistern::Service
+    class Real
+    end
+  end
+
+  class SampleService::GetSample < Cistern::Request
+    service SampleService
+
+    def real(*args)
+      args
+    end
+  end
+
+  class ShowSamples < Cistern::Request
+    service SampleService, method: :list_samples
+
+    def real(*args)
+      {"samples" => args}
+    end
+  end
+
+  it "allows requests to be created in a forward compatible structure" do
+    expect(SampleService.new.get_sample("likewhoa")).to   contain_exactly("likewhoa")
+    expect(SampleService.new.list_samples("likewhoa")).to eq("samples" => ["likewhoa"])
+  end
+end

data/spec/spec_helper.rb

@@ -8,8 +8,6 @@ require File.expand_path('../../lib/cistern', __FILE__)
 Bundler.require(:test)
 
 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: 0.11.3
+  version: 0.12.1
 platform: ruby
 authors:
 - Josh Lane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-09-01 00:00:00.000000000 Z
 dependencies: []
 description: API client framework extracted from Fog
 email:
@@ -36,12 +36,15 @@ files:
 - lib/cistern/data/redis.rb
 - lib/cistern/formatter.rb
 - lib/cistern/formatter/awesome_print.rb
+- lib/cistern/formatter/default.rb
 - lib/cistern/formatter/formatador.rb
 - lib/cistern/hash.rb
 - lib/cistern/mock.rb
 - lib/cistern/model.rb
+- lib/cistern/request.rb
 - lib/cistern/service.rb
 - lib/cistern/singular.rb
+- lib/cistern/string.rb
 - lib/cistern/timeout.rb
 - lib/cistern/version.rb
 - lib/cistern/wait_for.rb
@@ -51,6 +54,7 @@ files:
 - spec/hash_spec.rb
 - spec/mock_data_spec.rb
 - spec/model_spec.rb
+- spec/request_spec.rb
 - spec/singular_spec.rb
 - spec/spec_helper.rb
 - spec/wait_for_spec.rb
@@ -74,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: API client framework
@@ -85,7 +89,7 @@ test_files:
 - spec/hash_spec.rb
 - spec/mock_data_spec.rb
 - spec/model_spec.rb
+- spec/request_spec.rb
 - spec/singular_spec.rb
 - spec/spec_helper.rb
 - spec/wait_for_spec.rb
-has_rdoc: