pipeline_dealers 0.0.1

data/spec/pipeline_dealers/model/has_custom_fields_spec.rb

@@ -0,0 +1,115 @@
+require "pipeline_dealers"
+
+describe PipelineDealers::Model::HasCustomFields do
+  class ModelWithCustomFields < PipelineDealers::Model
+    include HasCustomFields
+    self.collection_url = "models"
+    self.attribute_name = "model"
+    attrs :name
+  end
+
+  class CustomModelField < PipelineDealers::Model::CustomField
+    self.collection_url = "admin/model_custom_field_labels"
+  end
+
+  let(:client)     { PipelineDealers::Client.new }
+  let(:backend)    { client.backend }
+  let(:connection) { backend.connection }
+
+  let(:collection) do
+    PipelineDealers::Backend::Http::Collection.new(backend, client: double("Client"), model_klass: ModelWithCustomFields, custom_fields: { model_klass: CustomModelField, cached: true, cache_key: :custom_field_cache_key })
+  end
+
+  let(:custom_attributes) { {
+
+    "custom_label_90" => 42,
+    "custom_label_91" => "Yeah"
+  } }
+
+  let(:custom_field_label_entries) {
+    [
+      {
+        "id"=>90,
+        "name"=>"TheAnswerForEverything",
+        "is_required"=>false,
+        "field_type"=>"numeric"
+      },
+      {
+        "id"=>91,
+        "name"=>"Really?",
+        "is_required"=>false,
+        "field_type"=>"text"
+      }
+    ]
+  }
+
+  let(:custom_field_labels) { {
+     "entries"=> custom_field_label_entries,
+     "pagination" => {"page" => 1, "pages" => 1, "per_page" => 2, "total" => 2}
+    }
+  }
+
+  subject { ModelWithCustomFields.new(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"]) }
+    end
+
+    it "fetcheing the translation map is cache" do
+      connection.should_receive(:get).once.with("admin/model_custom_field_labels.json", anything()).and_return([200, custom_field_labels])
+      subject.custom_fields
+      subject.custom_fields
+    end
+
+   it "translates the custom fields to recognizable labels" do
+      connection.should_receive(:get).once.with("admin/model_custom_field_labels.json", anything()).and_return([200, custom_field_labels])
+
+      subject.custom_fields.should == {
+        "TheAnswerForEverything" => 42,
+        "Really?" => "Yeah"
+      }
+    end
+  end
+
+  context "storing" do
+    before { client.stub(:model_custom_fields).and_return { PLD::CustomField::Collection.new(backend, klass: CustomModelField) } }
+
+    it "reposts the correct attributes" do
+      expected_attributes = {
+        "model" => {
+          "name" => "Springest",
+          "custom_fields" => custom_attributes
+         }
+      }
+
+      connection.should_receive(:get).once.with("admin/model_custom_field_labels.json", anything()).and_return([200, custom_field_labels])
+      connection.should_receive(:put).once.with("models/123.json", expected_attributes).and_return([200, expected_attributes[:model]])
+
+      subject.save
+    end
+
+    let(:updated_custom_attributes) { {
+      "custom_label_90" => 43,
+      "custom_label_91" => "Whoo"
+    } }
+
+    it "posts the correct change" do
+      expected_attributes = {
+        "model" => {
+          "name" => "Springest",
+          "custom_fields" => updated_custom_attributes
+         }
+      }
+
+      connection.should_receive(:get).once.with("admin/model_custom_field_labels.json", anything()).and_return([200, custom_field_labels])
+      connection.should_receive(:put).once.with("models/123.json", expected_attributes).and_return([200, expected_attributes[:model]])
+
+      subject.custom_fields["TheAnswerForEverything"] = 43
+      subject.custom_fields["Really?"] = "Whoo"
+      subject.save
+    end
+  end
+end

data/spec/pipeline_dealers/model_spec.rb

@@ -0,0 +1,33 @@
+require "pipeline_dealers"
+require "support/test_model"
+
+describe PipelineDealers::Model do
+  subject { TestModel }
+
+  context "initialization" do
+    let(:model) { subject.new(attributes: {name: "Springest"}) }
+
+    it "can access the name by the name method" do
+      model.name.should == "Springest"
+    end
+
+    it "can access the name by via attributes['name']" do
+      model.attributes['name'].should == "Springest"
+    end
+
+    it "can access the name by via attributes[:name]" do
+      model.attributes[:name].should == "Springest"
+    end
+  end
+
+  context "setting attributes" do
+    let(:model) { subject.new({}) }
+    context "name is set using accessor" do
+      before { model.name = "Springest" }
+
+      it "is readable via the accessor" do
+        model.name.should == "Springest"
+      end
+    end
+  end
+end

data/spec/pipeline_dealers/test_client_spec.rb

@@ -0,0 +1,80 @@
+require "pipeline_dealers"
+require "pipeline_dealers/test"
+
+module PipelineDealers
+  describe "Client with TestBackend"  do
+    subject { TestClient.new }
+
+    describe "storing a model" do
+      describe "#create" do
+        it "stores the model" do
+          expect do
+            subject.companies.create(name: "My Company")
+          end.to change { subject.companies.count }.from(0).to(1)
+        end
+      end
+
+      describe "#save" do
+        let(:model) { subject.companies.new(name: "Some Company") }
+
+        it "stores the model data" do
+          expect { model.save }.to change(model, :id).from(nil).to(Integer)
+        end
+      end
+
+      let(:other_client) { TestClient.new }
+
+      it "is accessable from all instances" do
+        other_client.companies.first.should == subject.companies.first
+      end
+    end
+
+    describe "destroying a model" do
+      let!(:model) { subject.companies.create(name: "My Company") }
+
+      describe "#destroy" do
+        it "decreases the count" do
+          expect { model.destroy }.to change { subject.companies.count }.from(1).to(0)
+        end
+
+        it "empties the collection" do
+          expect { model.destroy }.to change {
+            subject.companies.all.to_a == []
+          }.from(false).to(true)
+        end
+      end
+    end
+
+    describe "Custom fields" do
+      context "not defined" do
+        let(:model) { subject.companies.new }
+
+        describe "assignment" do
+          it "does not throw an exception" do
+            expect { model.custom_fields[:field] = :value }.not_to raise_error
+          end
+
+          it "stores the custom field" do
+            model.custom_fields[:field] = :value
+            model.custom_fields[:field].should == :value
+          end
+        end
+
+        describe "retrieval" do
+          let(:model) { subject.companies.new }
+
+          before do
+            model.custom_fields[:field] = :value
+            model.save
+          end
+
+          describe "via the collection" do
+            it "return the correct value" do
+              subject.companies.first.custom_fields[:field].should == :value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/test_model.rb

@@ -0,0 +1,6 @@
+class TestModel < PipelineDealers::Model
+  self.collection_url = "test_models"
+  self.attribute_name = "moeha"
+
+  attrs :name
+end

data/todo.md

@@ -0,0 +1,13 @@
+# Things that need to be done
+
+- Basic models:
+  1. Deals
+  2. Documents
+- The other admin resources
+  1. Deal stages
+  2. Note categories
+  3. Lead sources
+  4. Deal custom fields
+  5. Lead statuses
+  6. Predefined contacts tags
+  7. Event categories

metadata

@@ -0,0 +1,291 @@
+--- !ruby/object:Gem::Specification
+name: pipeline_dealers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Maarten Hoogendoorn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+description: API client for PipelineDeals
+email:
+- maarten@springest.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/companies_create_and_destroy.rb
+- examples/companies_list_all.rb
+- examples/company_details.rb
+- examples/company_notes.rb
+- examples/company_people.rb
+- examples/config.rb
+- examples/find_person.rb
+- examples/list_custom_fields.rb
+- examples/people_create_and_destroy.rb
+- examples/people_list_all.rb
+- lib/pipeline_dealers.rb
+- lib/pipeline_dealers/backend/base.rb
+- lib/pipeline_dealers/backend/base/backend.rb
+- lib/pipeline_dealers/backend/base/collection.rb
+- lib/pipeline_dealers/backend/http.rb
+- lib/pipeline_dealers/backend/http/backend.rb
+- lib/pipeline_dealers/backend/http/collection.rb
+- lib/pipeline_dealers/backend/http/connection.rb
+- lib/pipeline_dealers/backend/http/fetcher.rb
+- lib/pipeline_dealers/backend/test.rb
+- lib/pipeline_dealers/backend/test/backend.rb
+- lib/pipeline_dealers/backend/test/collection.rb
+- lib/pipeline_dealers/client.rb
+- lib/pipeline_dealers/delegator.rb
+- lib/pipeline_dealers/error.rb
+- lib/pipeline_dealers/error/connection.rb
+- lib/pipeline_dealers/error/custom_field.rb
+- lib/pipeline_dealers/error/invalid_attribute.rb
+- lib/pipeline_dealers/limits.rb
+- lib/pipeline_dealers/model.rb
+- lib/pipeline_dealers/model/company.rb
+- lib/pipeline_dealers/model/company/custom_field.rb
+- lib/pipeline_dealers/model/custom_field.rb
+- lib/pipeline_dealers/model/has_custom_fields.rb
+- lib/pipeline_dealers/model/note.rb
+- lib/pipeline_dealers/model/person.rb
+- lib/pipeline_dealers/model/person/custom_field.rb
+- lib/pipeline_dealers/test.rb
+- lib/pipeline_dealers/version.rb
+- pipeline_dealers.gemspec
+- spec/acceptance/companies/creation_spec.rb
+- spec/acceptance/companies/custom_fields_spec.rb
+- spec/acceptance/companies/updating_spec.rb
+- spec/acceptance/people/creation_spec.rb
+- spec/pipeline_dealers/backend/http/backend_spec.rb
+- spec/pipeline_dealers/backend/http/collection_spec.rb
+- spec/pipeline_dealers/model/custom_field_spec.rb
+- spec/pipeline_dealers/model/has_custom_fields_spec.rb
+- spec/pipeline_dealers/model_spec.rb
+- spec/pipeline_dealers/test_client_spec.rb
+- spec/support/test_model.rb
+- todo.md
+homepage: https://github.com/Springest/pipeline_dealers
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: API client for PipelineDeals
+test_files:
+- spec/acceptance/companies/creation_spec.rb
+- spec/acceptance/companies/custom_fields_spec.rb
+- spec/acceptance/companies/updating_spec.rb
+- spec/acceptance/people/creation_spec.rb
+- spec/pipeline_dealers/backend/http/backend_spec.rb
+- spec/pipeline_dealers/backend/http/collection_spec.rb
+- spec/pipeline_dealers/model/custom_field_spec.rb
+- spec/pipeline_dealers/model/has_custom_fields_spec.rb
+- spec/pipeline_dealers/model_spec.rb
+- spec/pipeline_dealers/test_client_spec.rb
+- spec/support/test_model.rb