pipeline_dealers 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# 0.0.2
+- Made base model more robust
+- Made filtering & limiting work for TestClient.
+- Added interactive console example
+- Add rspec example
+
+# 0.0.1
+- Initial release

data/README.md

@@ -19,7 +19,7 @@ client = Pipelinedealers::Client.new(api_key: "z3kr3tp@zzw0rd")
 
 # Get all companies
 client.companies.all.each do |company|
- puts company.name
+  puts company.name
 end
 
 # Find company by ID
@@ -48,6 +48,7 @@ describe "MyClass" do
 end
 ```
 *Note:* Be sure to stub the client in your code. This only works if you use the same client reference in both the specs and your application.
+For more examples, see [these examples](examples/howto_rspec) and [how to run them](examples/howto_rspec/README.md)
 
 ## Contributing
 
@@ -61,4 +62,4 @@ end
 
 The awesome people at
 
-[![Springest](http://static-1.cdnhub.nl/images/logo-springest.jpg "Logo springest.com")](http://www.springest.com/about-springest)
+[![Springest](http://static-1.cdnhub.nl/images/logo-springest.jpg "Logo springest.com")](http://www.springest.com/)

data/examples/howto_rspec/README.md

@@ -0,0 +1,2 @@
+Run these specs from the top of the gem repository like this:
+$ bundle exec examples/howto\_rspec/SPEC\_spec.rb

data/examples/howto_rspec/notes_spec.rb

@@ -0,0 +1,30 @@
+require "pipeline_dealers"
+require "pipeline_dealers/test"
+
+
+class SomeClass
+  def pld_client
+    # Normally this gets executed, but not during this test
+    PipelineDealers::Client.new(SOME_OPTIONS)
+  end
+
+  def create_company
+    company = pld_client.companies.create(name: "MyCompany")
+    company.notes.create(content: "whoo, awesome")
+  end
+end
+
+describe SomeClass do
+  let(:client) { PipelineDealers::TestClient.new }
+  before { subject.stub(:pld_client).and_return(client) }
+
+  describe "#create_company" do
+    it "creates a company" do
+      expect { subject.create_company }.to change(client.companies, :count).by(1)
+    end
+
+    it "creates a note" do
+      expect { subject.create_company }.to change(client.notes, :count).by(1)
+    end
+  end
+end

data/examples/test_console.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "bundler"
+require "irb"
+
+Bundler.setup
+
+require "pipeline_dealers"
+require "pipeline_dealers/test"
+
+# Hack to force context
+module IRB
+  def self.start_session(binding)
+    unless @__initialized
+      args = ARGV
+      ARGV.replace(ARGV.dup)
+      IRB.setup(nil)
+      ARGV.replace(args)
+      @__initialized = true
+    end
+    workspace = WorkSpace.new(binding)
+    irb = Irb.new(workspace)
+    @CONF[:IRB_RC].call(irb.context) if @CONF[:IRB_RC]
+    @CONF[:MAIN_CONTEXT] = irb.context
+
+    catch(:IRB_EXIT) do
+      irb.eval_input
+    end
+  end
+end
+
+
+module Context
+  extend self
+  def test_client
+    @test_client ||= PipelineDealers::TestClient.new
+  end
+end
+
+
+puts "You can access the test_client with 'test_client'."
+IRB.start_session(Context)

data/lib/pipeline_dealers/backend/base/backend.rb

@@ -8,6 +8,19 @@ module PipelineDealers
 
         @cache[key]
       end
+
+      # This base version just sets the condition fields from the collection
+      # to the model, if they're not set manually
+      def save(collection, model)
+        if collection.options.has_key?(:where)
+          collection.options[:where].each do |field, value|
+            if model.send(field).nil?
+              setter = :"#{field}="
+              model.send(setter, value)
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/pipeline_dealers/backend/base/collection.rb

@@ -9,7 +9,7 @@ module PipelineDealers
         delegate :connection,     to: :backend
         delegate :collection_url, to: :model_klass
 
-        attr_reader :model_klass, :backend, :client
+        attr_reader :model_klass, :backend, :client, :options
 
         def initialize(backend, options)
           @options     = options
@@ -34,6 +34,10 @@ module PipelineDealers
           end
         end
 
+        def each &block
+          raise "Should be implemented by backend!"
+        end
+
         def select &block
           results = []
 
@@ -47,7 +51,8 @@ module PipelineDealers
         def collect &operation
           results = []
 
-          self.each do
+          self.each do |model|
+            results << operation.call(model)
           end
 
           results
@@ -78,7 +83,7 @@ module PipelineDealers
             attributes = @options[:new_defaults].merge(attributes)
           end
 
-          model_klass.new(collection: self, record_new: true, attributes: attributes)
+          model_klass.new(collection: self, client: @client, record_new: true, attributes: attributes)
         end
 
         def create(attributes = {})

data/lib/pipeline_dealers/backend/http/backend.rb

@@ -14,6 +14,8 @@ module PipelineDealers
       end
 
       def save(collection, model)
+        super
+
         model_attr_name = model.class.attribute_name
 
         if model_attr_name.nil?

data/lib/pipeline_dealers/backend/http/collection.rb

@@ -5,7 +5,7 @@ module PipelineDealers
         def find id
           status, result = @backend.connection.get(collection_url + "/#{id}.json", {})
           if status == 200
-            model_klass.new(collection: self, persisted: true, attributes: result)
+            model_klass.new(client: @client, collection: self, persisted: true, attributes: result)
           else
             raise Error::NotFound
           end
@@ -16,16 +16,6 @@ module PipelineDealers
             operation.call(result)
           end
         end
-
-        def collect &operation
-          results = []
-
-          Fetcher.new(@backend.connection, self, model_klass, @options).each do |result|
-            results << operation.call(result)
-          end
-
-          results
-        end
       end
     end
   end

data/lib/pipeline_dealers/backend/test/backend.rb

@@ -1,8 +1,6 @@
-require_relative "collection"
-
 module PipelineDealers
   module Backend
-    class Test
+    class Test < Base
       attr_reader :items
 
       def cache key
@@ -11,7 +9,7 @@ module PipelineDealers
 
       def initialize(client)
         @client = client
-        @items = Hash.new([])
+        @items = Hash.new
         @last_id = 41
       end
 
@@ -20,14 +18,20 @@ module PipelineDealers
       end
 
       def save(collection, model)
+        super
+
+        @items[model.class] ||= []
         @items[model.class] << model
+
         if model.id.nil?
           model.send(:instance_variable_set, :@id, @last_id += 1)
         end
       end
 
       def destroy(collection, to_remove)
-        @items[to_remove.class].reject! { |model| model == to_remove }
+        if @items.has_key?(to_remove.class)
+          @items[to_remove.class].reject! { |model| model == to_remove }
+        end
       end
     end
   end

data/lib/pipeline_dealers/backend/test/collection.rb

@@ -18,15 +18,31 @@ module PipelineDealers
           items.each &operation
         end
 
-        def collect &operation
-          items.collect &operation
-        end
-
         protected
 
         def items
-          @backend.items[@model_klass]
-          @backend.items[@model_klass]
+          if @options.has_key?(:limit)
+            filtered_items[0..(@options[:limit]-1)]
+          else
+            filtered_items
+          end
+        end
+
+        def filtered_items
+          if not @options.has_key?(:where)
+            @backend.items[@model_klass] || []
+          else
+            (@backend.items[@model_klass] || []).select do |model|
+              res = @options[:where].detect do |field, value| # 'return' true when a condition does NOT hold
+                if !@model_klass.attributes.has_key?(field) && field != :id
+                  raise("Model #{@model_klass} doesn't have a field #{field.inspect}")
+                else
+                  model.send(field) != value
+                end
+              end
+              res == nil # All conditions did hold
+            end
+          end
         end
       end
     end

data/lib/pipeline_dealers/model.rb

@@ -50,8 +50,8 @@ module PipelineDealers
     def initialize(options = {})
       @options    = options
       @persisted  = options.delete(:persisted) == true
-      @client     = options.delete(:client)
-      @collection = options.delete(:collection)
+      @client     = options.delete(:client) || raise("No client given")
+      @collection = options.delete(:collection) || raise("No collection given")
 
       import_attributes! options.delete(:attributes)
     end

data/lib/pipeline_dealers/version.rb

@@ -1,3 +1,3 @@
 module PipelineDealers
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/pipeline_dealers/backend/http/backend_spec.rb

@@ -28,7 +28,7 @@ module PipelineDealers::Backend
      end
 
      context "that has been persisted" do
-       let(:model) { TestModel.new(collection: collection, persisted: true, attributes: { "id" => 123, name: "Springest"}) }
+       let(:model) { TestModel.new(client: double("Client"), collection: collection, persisted: true, attributes: { "id" => 123, name: "Springest"}) }
        after(:each) { model.save }
 
        it "uses the PUT method" do

data/spec/pipeline_dealers/backend/http/collection_spec.rb

@@ -44,8 +44,8 @@ describe PipelineDealers::Backend::Http::Collection do
       ]
     end
 
-    let(:model_a) { TestModel.new(collection: subject, attributes: { name: "Maarten" }) }
-    let(:model_b) { TestModel.new(collection: subject, attributes: { name: "Hoogendoorn" }) }
+    let(:model_a) { TestModel.new(client: double("Client"), collection: subject, attributes: { name: "Maarten" }) }
+    let(:model_b) { TestModel.new(client: double("Client"), collection: subject, attributes: { name: "Hoogendoorn" }) }
 
     it "fetches the correct models" do
       connection.should_receive(:get).ordered.once.with(*expected_params_a).and_return(response_a)
@@ -84,7 +84,7 @@ describe PipelineDealers::Backend::Http::Collection do
       ]
     end
 
-    let(:model_a) { TestModel.new(collection: subject, attributes: { name: "Maarten"}) }
+    let(:model_a) { TestModel.new(client: double("client"), collection: subject, attributes: { name: "Maarten"}) }
 
     it "fetches only the resouces before the limit" do
       connection.should_receive(:get).once.with(*expected_params).and_return(response)

data/spec/pipeline_dealers/model/custom_field_spec.rb

@@ -2,7 +2,8 @@ require "pipeline_dealers"
 
 module PipelineDealers
   class Model
-    describe CustomField do
+    describe CustomField, focus: true do
+      subject { described_class.new(client: double("Client"), collection: double("Client")) }
       let(:model) { nil }
 
       describe "decode" do
@@ -32,10 +33,14 @@ module PipelineDealers
 
         context "dropdown" do
           subject do
-            CustomField.new(attributes: {
-              "field_type" => "dropdown",
-              "custom_field_label_dropdown_entries" => [{"id" => 123, "value" => "My Item"}]
-            })
+            CustomField.new(
+              client: double("Client"),
+              collection: double("Collection"),
+              attributes: {
+                "field_type" => "dropdown",
+                "custom_field_label_dropdown_entries" => [{"id" => 123, "value" => "My Item"}]
+              }
+            )
           end
 
           it "decodes correctly" do
@@ -45,10 +50,14 @@ module PipelineDealers
 
         context "multi_select" do
           subject do
-            CustomField.new(attributes: {
-              "field_type" => "multi_select",
-              "custom_field_label_dropdown_entries" => [{"id" => 123, "value" => "My Item"}]
-            })
+            CustomField.new(
+              client: double("Client"),
+              collection: double("Collection"),
+              attributes: {
+                "field_type" => "multi_select",
+                "custom_field_label_dropdown_entries" => [{"id" => 123, "value" => "My Item"}]
+              }
+            )
           end
 
           it "decodes correctly" do
@@ -92,10 +101,14 @@ module PipelineDealers
 
         context "dropdown" do
           subject do
-            CustomField.new(attributes: {
-              "field_type" => "dropdown",
-              "custom_field_label_dropdown_entries" => [{"id" => 123, "value" => "My Item"}]
-            })
+            CustomField.new(
+              client: double("Client"),
+              collection: double("Collection"),
+              attributes: {
+                "field_type" => "dropdown",
+                "custom_field_label_dropdown_entries" => [{"id" => 123, "value" => "My Item"}]
+              }
+            )
           end
 
           it "encodes correctly" do
@@ -105,10 +118,14 @@ module PipelineDealers
 
         context "multi_select" do
           subject do
-            CustomField.new(attributes: {
-              "field_type" => "multi_select",
-              "custom_field_label_dropdown_entries" => [{"id" => 123, "value" => "My Item"}]
-            })
+            CustomField.new(
+              client: double("Client"),
+              collection: double("Collection"),
+              attributes: {
+                "field_type" => "multi_select",
+                "custom_field_label_dropdown_entries" => [{"id" => 123, "value" => "My Item"}]
+              }
+            )
           end
 
           it "encodes correctly" do

data/spec/pipeline_dealers/model/has_custom_fields_spec.rb

@@ -49,13 +49,13 @@ describe PipelineDealers::Model::HasCustomFields do
     }
   }
 
-  subject { ModelWithCustomFields.new(collection: collection, persisted: true, attributes: { "id" => 123, name: "Springest", custom_fields: custom_attributes} ) }
+  subject { ModelWithCustomFields.new(client: double("Client"), collection: collection, persisted: true, attributes: { "id" => 123, name: "Springest", custom_fields: custom_attributes} ) }
 
   context "reading custom fields" do
     before { client.stub(:custom_fields).and_return { PLD::CustomField::Collection.new(backend, klass: CustomModelField, cached: true, cache_key: :custom_field_cache_key) } }
 
     let(:custom_field_models) do
-       custom_field_labels.collect { |label| CustomModelField.new(collection: model_custom_fields, persisted: true, attributes: label["entries"]) }
+       custom_field_labels.collect { |label| CustomModelField.new(client: double("Client"), collection: model_custom_fields, persisted: true, attributes: label["entries"]) }
     end
 
     it "fetcheing the translation map is cache" do

data/spec/pipeline_dealers/model_spec.rb

@@ -5,7 +5,7 @@ describe PipelineDealers::Model do
   subject { TestModel }
 
   context "initialization" do
-    let(:model) { subject.new(attributes: {name: "Springest"}) }
+    let(:model) { subject.new(client: double("Client"), collection: double("Connection"), attributes: {name: "Springest"}) }
 
     it "can access the name by the name method" do
       model.name.should == "Springest"
@@ -21,7 +21,7 @@ describe PipelineDealers::Model do
   end
 
   context "setting attributes" do
-    let(:model) { subject.new({}) }
+    let(:model) { subject.new(client: double("Client"), collection: double("Collection"), attributes: {}) }
     context "name is set using accessor" do
       before { model.name = "Springest" }
 

data/spec/pipeline_dealers/test_client_spec.rb

@@ -3,7 +3,8 @@ require "pipeline_dealers/test"
 
 module PipelineDealers
   describe "Client with TestBackend"  do
-    subject { TestClient.new }
+    let(:client) { TestClient.new }
+    subject { client }
 
     describe "storing a model" do
       describe "#create" do
@@ -27,6 +28,14 @@ module PipelineDealers
       it "is accessable from all instances" do
         other_client.companies.first.should == subject.companies.first
       end
+
+      context "when stored" do
+        let!(:company) { subject.companies.create(name: "Springest") }
+
+        it "makes it able to find it using .first" do
+          subject.companies.first.should == company
+        end
+      end
     end
 
     describe "destroying a model" do
@@ -76,5 +85,51 @@ module PipelineDealers
         end
       end
     end
+
+    describe "Notes on nested model" do
+      let!(:model) { subject.companies.create(name: "AWESOME") }
+
+      context "no notes added" do
+        it "has no notes" do
+          model.notes.all.to_a.should == []
+        end
+      end
+
+      context "after a note has been added" do
+        it "has one note" do
+          expect do
+            model.notes.create(content: "Note Content")
+          end.to change { model.notes.all.to_a.length }.by(1)
+        end
+      end
+    end
+
+    describe "selection options on collections" do
+      let!(:company_a) { client.companies.create(name: "Company A") }
+      let!(:company_b) { client.companies.create(name: "Company B") }
+
+      context "without any selections" do
+        subject { client.companies.all.to_a }
+        it { should =~ [company_a, company_b] }
+      end
+
+      context "with limit" do
+        subject { client.companies.limit(1).to_a }
+        its(:length) { should == 1 }
+        it { should =~ [company_a] }
+      end
+
+      context "filtered" do
+        context "on company a" do
+          subject { client.companies.where(id: company_a.id).all.to_a }
+          it { should =~ [company_a] }
+        end
+
+        context "on company b" do
+          subject { client.companies.where(id: company_b.id).all.to_a }
+          it { should =~ [company_b] }
+        end
+      end
+    end
   end
 end

data/todo.md

@@ -11,3 +11,5 @@
   5. Lead statuses
   6. Predefined contacts tags
   7. Event categories
+
+- Add counting to all collections (per_page = 1, count nr pages)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pipeline_dealers
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-04 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -196,6 +196,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -208,9 +209,12 @@ files:
 - examples/company_people.rb
 - examples/config.rb
 - examples/find_person.rb
+- examples/howto_rspec/README.md
+- examples/howto_rspec/notes_spec.rb
 - examples/list_custom_fields.rb
 - examples/people_create_and_destroy.rb
 - examples/people_list_all.rb
+- examples/test_console.rb
 - lib/pipeline_dealers.rb
 - lib/pipeline_dealers/backend/base.rb
 - lib/pipeline_dealers/backend/base/backend.rb