pipe_line_dealer 0.1.0

data/lib/pipe_line_dealer/model/base.rb

@@ -0,0 +1,133 @@
+require "json"
+require "active_support/hash_with_indifferent_access"
+
+module PipeLineDealer
+  module Model
+    class Base
+      include Concern::Persistance
+      attr_reader :attributes
+      attr_reader :id
+
+      def initialize options = {}
+        @options       = options
+        @persisted     = !!@options[:persisted]
+        @collection    = @options[:collection]
+
+        import_attributes! @options[:attributes]
+      end
+
+      # TODO : remove check of methode bestaat
+      def attributes_for_saving(attributes)
+        attributes
+      end
+
+
+      def ==(other)
+        if other.kind_of?(self.class)
+          other.attributes == self.attributes
+        else
+          super(other)
+        end
+      end
+
+      def to_json
+        JSON.dump(@attributes)
+      end
+
+      def self.attrs *attrs
+        if attrs.last.kind_of?(Hash)
+          options = attrs.pop
+        else
+          options = {}
+        end
+
+        attrs.each do |attr|
+          pld_attr attr, options
+        end
+      end
+
+      def self.inherited(subklass)
+        @attributes ||= {}
+
+        # Copy all attributes to the children.
+        @attributes.each do |attr, options|
+          subklass.pld_attr attr, options
+        end
+      end
+
+      def self.pld_attr attr, options = {}
+        @attributes ||= {}
+        @attributes[attr] = options
+
+        # Getter
+        define_method attr do
+          @attributes[attr.to_s]
+        end
+
+        # Setter
+        define_method "#{attr}=".to_sym do |value|
+          @attributes[attr.to_s] = value
+        end
+      end
+
+      def to_s
+        "<PipeLineDealer::Model:#{__id__} klass=#{self.class.name} id=#{@id} attributes=#{@attributes.inspect}>"
+      end
+
+      protected
+
+      def import_attributes! attributes
+        @attributes    = stringify_keys(attributes || {})
+        @id            = @attributes.delete(:id)
+
+        # Give subclasses the opportunity to hook in here.
+        process_attributes if respond_to?(:process_attributes)
+
+        check_for_non_existent_attributes!
+      end
+
+      def model_attribute_name
+        self.class.instance_variable_get(:@model_attribute_name) || raise("#{self.class.inspect}::@model_attribute_name is missing!")
+      end
+
+      # Recursively converts a hash structure with symbol keys to a hash
+      # with indifferent keys
+      def stringify_keys original
+        result = HashWithIndifferentAccess.new
+
+        original.each do |key, value|
+          result[key] = stringify_value(value)
+        end
+
+        result
+      end
+
+      def stringify_value value
+        case value
+        when String, Fixnum, NilClass, FalseClass, TrueClass
+          return value
+        when Hash, HashWithIndifferentAccess
+          return stringify_keys(value)
+        when Array
+          return value.collect { |item| stringify_value(item) }
+        else
+          raise "Unkown type: #{value.class}"
+        end
+      end
+
+      def valid_attribute_names
+        self.class.instance_variable_get(:@attributes).keys || []
+      end
+
+      def check_for_non_existent_attributes!
+        attribute_keys = @attributes.keys.collect(&:to_sym)
+
+        invalid_attributes = attribute_keys - valid_attribute_names
+
+        if invalid_attributes.any?
+          raise Error::InvalidAttributeName.new(self.class, invalid_attributes.first)
+        end
+      end
+    end
+  end
+end

data/lib/pipe_line_dealer/model/company/custom_field.rb

@@ -0,0 +1,7 @@
+module PipeLineDealer
+  class Company
+    class CustomField < PipeLineDealer::CustomField
+      @collection_url = "admin/company_custom_field_labels"
+    end
+  end
+end

data/lib/pipe_line_dealer/model/company.rb

@@ -0,0 +1,37 @@
+module PipeLineDealer
+ class Company < Model::Base
+    @collection_url       = "companies"
+    @model_attribute_name = "company"
+    @custom_field_client_method = :custom_company_fields
+
+    include CustomFields
+
+    attrs :address_1, :address_2, :city, :country,
+      :name,  :description,
+      :image_thumb_url,
+      :import_id,
+      :email, :fax, :phone1, :phone1_desc, :phone2, :phone2_desc, :phone3, :phone3_desc, :phone4, :phone4_desc, :postal_code, :state, :web,
+      :total_pipeline, :won_deals_total,
+      :created_at, :updated_at
+
+
+    def attributes_for_saving_with_company attributes
+      attributes = attributes_for_saving_without_company(attributes)
+
+      attributes.delete(:total_pipeline)
+      attributes.delete(:won_deals)
+      attributes.delete(:won_deals_total)
+      attributes.delete(:image_thumb_url) if attributes[:image_thumb_url] == "/images/thumb/missing_company.png"
+
+      attributes
+    end
+
+    alias_method_chain :attributes_for_saving, :company
+
+    def notes
+      Collection.new(@collection.client, klass: Note, cached: false).\
+        where(query: { company_id: self.id }).\
+        on_new_defaults(company_id: self.id)
+    end
+  end
+end

data/lib/pipe_line_dealer/model/custom_field.rb

@@ -0,0 +1,73 @@
+module PipeLineDealer
+  class CustomField < Model::Base
+    attrs :name, :is_required, :field_type
+    attr_reader :dropdown_entries
+
+    def process_attributes
+      @dropdown_entries = @attributes.delete(:custom_field_label_dropdown_entries)
+    end
+
+    def decode(model, value)
+      case field_type
+      when "numeric"           then return value
+      when "text"              then return value
+      when "currency"          then return value
+      when "dropdown"          then return decode_dropdown(model, value)
+      when "multi_select"      then return decode_multi_select(model, value)
+      when "multi_association" then return decode_multi_association(model, value)
+      else; raise "Unkown PLD field type! #{field_type.inspect}"
+      end
+    end
+
+    def encode(model, value)
+      case field_type
+      when "numeric"           then return value
+      when "text"              then return value
+      when "currency"          then return value
+      when "dropdown"          then return encode_dropdown(model, value)
+      when "multi_select"      then return encode_multi_select(model, value)
+      when "multi_association" then return encode_multi_association(model, value)
+      else; raise "Unkown PLD field type! #{field_type.inspect}"
+      end
+    end
+
+    protected
+
+    def decode_dropdown(model, id)
+      @dropdown_entries.each do |entry|
+        return entry["value"] if entry["id"] == id
+      end
+
+      raise Error::InvalidAttributeValue.new(model, name, id)
+    end
+
+    def encode_dropdown(model, value)
+      @dropdown_entries.each do |entry|
+        return entry["id"] if entry["value"] == value
+      end
+
+      raise Error::InvalidAttributeValue.new(model, name, value)
+    end
+
+    def decode_multi_select(model, ids)
+      ids.collect do |id|
+        decode_dropdown(model, id)
+      end
+    end
+
+    def encode_multi_select(model, values)
+      values.collect do |value|
+        encode_dropdown(model, value)
+      end
+    end
+
+    #TODO: Not implemented yet.
+    def decode_multi_association(model, value)
+      value
+    end
+
+    def encode_multi_association(model, value)
+      value
+    end
+  end
+end

data/lib/pipe_line_dealer/model/note.rb

@@ -0,0 +1,32 @@
+module PipeLineDealer
+  class Note < Model::Base
+    @collection_url             = "notes"
+    @model_attribute_name       = "note"
+
+#    include CustomFields
+
+    @custom_field_client_method = :custom_person_fields
+    attrs :deal, :deal_id, :person_id, :company_id, :title, :created_by_user_id, :note_category_id, :created_at, :updated_at, :company, :person, :created_by_user, :note_category, :content
+
+    def process_attributes
+      # TODO: Remove these convenience objects for now
+    end
+
+    def attributes_for_saving_with_note attributes
+      attributes = attributes_for_saving_without_note(attributes)
+
+      attributes.delete(:deal)
+      attributes.delete(:created_by_user)
+      attributes.delete(:note_category)
+
+      attributes.delete(:created_at)
+      attributes.delete(:updated_at)
+      attributes.delete(:company)
+      attributes.delete(:person)
+
+      attributes
+    end
+
+    alias_method_chain :attributes_for_saving, :note
+  end
+end

data/lib/pipe_line_dealer/model/person/custom_field.rb

@@ -0,0 +1,7 @@
+module PipeLineDealer
+  class Person
+    class CustomField < PipeLineDealer::CustomField
+      @collection_url = "admin/person_custom_field_labels"
+    end
+  end
+end

data/lib/pipe_line_dealer/model/person.rb

@@ -0,0 +1,36 @@
+module PipeLineDealer
+  class Person < Model::Base
+    @collection_url             = "people"
+    @model_attribute_name       = "person"
+    @custom_field_client_method = :custom_person_fields
+
+#    include CustomFields
+
+    attrs :company, :company_id, :company_name, :created_at, :deal_ids, :deals, :email, :email2, :facebook_url, :fax, :first_name, :full_name, :home_address_1, :home_address_2, :home_city, :home_country, :home_email, :home_phone, :home_postal_code, :home_state, :image_thumb_url, :instant_message, :last_name, :lead_source, :lead_status, :linked_in_url, :mobile, :phone, :position, :predefined_contacts_tag_ids, :predefined_contacts_tags, :total_pipeline, :twitter, :type, :updated_at, :user, :user_id, :viewed_at, :website, :won_deals_total, :work_address_1, :work_address_2, :work_city, :work_country, :work_postal_code, :work_state
+
+    def process_attributes
+      @attributes.delete(:custom_fields)
+    end
+
+    #TODO: make sure that removeing one of these causes problems.
+    def attributes_for_saving_with_person attributes
+      attributes = attributes_for_saving_without_person(attributes)
+
+      attributes.delete(:company)
+      attributes.delete(:deals)
+      attributes.delete(:won_deals_total)
+      attributes.delete(:lead_status)
+      attributes.delete(:viewed_at)
+      attributes.delete(:deal_ids)
+      attributes.delete(:predefined_contacts_tag_ids)
+      attributes.delete(:user_id)
+      attributes.delete(:user)
+
+      attributes.delete(:image_thumb_url) if attributes[:image_thumb_url] == "/images/thumb/missing.png"
+
+      attributes
+    end
+
+    alias_method_chain :attributes_for_saving, :person
+  end
+end

data/lib/pipe_line_dealer/version.rb

@@ -0,0 +1,10 @@
+module PipeLineDealer
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    BETA  = nil
+  end
+
+  VERSION = [Version::MAJOR, Version::MINOR, Version::PATCH, Version::BETA].reject(&:nil?).collect(&:to_s).join(".")
+end

data/lib/pipe_line_dealer.rb

@@ -0,0 +1,44 @@
+require "active_support/concern"
+require "faraday"
+require "multi_json"
+
+module PipeLineDealer
+  %W{
+    limits
+    version
+
+    error
+    error/no_such_custom_field
+    error/invalid_attribute
+    error/connection
+
+    collection/concerns
+    collection/concerns/fetching
+    collection/concerns/results_fetcher
+    collection/concerns/create_and_update
+    collection
+
+    model/base/concern/persistance
+    model/base
+    model/custom_field
+
+    custom_fields
+    custom_field/collection
+
+    model/company
+    model/company/custom_field
+
+    model/person
+    model/person/custom_field
+
+    model/note
+
+    client/connection
+    client
+  }.each { |file| require(File.join("pipe_line_dealer", file))}
+end
+
+# Shortcut :)
+if not defined?(PLD)
+  PLD = PipeLineDealer
+end

data/pipe_line_dealer.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pipe_line_dealer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pipe_line_dealer"
+  s.version     = PipeLineDealer::VERSION
+  s.authors     = ["Maarten Hoogendoorn"]
+  s.email       = ["maarten@springest.com"]
+  s.homepage    = "http://github.com/moretea/pipe_line_dealer"
+  s.summary     = "A Ruby library that implements the PipelineDeals.com API."
+  s.description = s.summary
+
+  s.required_ruby_version = ">=1.9.2"
+  
+  # Dependencies
+  s.add_dependency "faraday", "~> 0.8.0"
+  s.add_dependency "faraday_middleware", "~> 0.9.0"
+  s.add_dependency "multi_json", "~> 1.3.6"
+  s.add_dependency "activesupport", ">= 3.2.0"
+
+  s.add_development_dependency "debugger"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "webmock"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "rb-inotify"
+  s.add_development_dependency "fuubar"
+  s.add_development_dependency "reek"
+
+  # Make development a charm
+  if RUBY_PLATFORM.include?("darwin")
+    s.add_development_dependency "growl", "~> 1.0.3"
+    s.add_development_dependency "rb-fsevent"
+  elsif RUBY_PLATFORM.include?("linux")
+    s.add_development_dependency "rb-inotify"
+  end
+
+  # Files
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/acceptance/companies/creation_spec.rb

@@ -0,0 +1,31 @@
+require "helper"
+
+describe "Company", :acceptance do
+  describe "creation" do
+    include AcceptanceHelper
+
+    context "using client.companies.new" do
+      let(:company) { client.companies.new(name: "Meh") }
+
+      context "with a valid model" do
+        before { company.name = "Meh" }
+
+        context "when saved" do
+          it "returns a model" do
+            company.save.should be_kind_of PLD::Model::Base
+          end
+        end
+      end
+
+      context "with an invalid model" do
+        before { company.name = nil }
+
+        context "when saved" do
+          it "raises an error" do
+            expect { company.save}.to raise_error PipeLineDealer::Error::Connection::Unprocessable
+          end
+        end
+      end
+    end
+  end
+end

data/spec/acceptance/companies/custom_fields_spec.rb

@@ -0,0 +1,7 @@
+require "helper"
+
+describe "Company", :acceptance do
+  describe "custom fields" do
+    pending "Can't test this (yet), since it's not accessible via the API."
+  end
+end

data/spec/acceptance/companies/updating_spec.rb

@@ -0,0 +1,35 @@
+require "helper"
+
+describe "Company", :acceptance do
+  describe "updating" do
+    include AcceptanceHelper
+    let(:company) { client.companies.create(name: "Old") }
+
+    context "using client.companies.new" do
+      context "with a valid model" do
+        before { company.name = "new" }
+
+        context "when saved" do
+          it "returns a model" do
+            company.save.should be_kind_of PLD::Model::Base
+          end
+
+          it "has the new name" do
+            company.save
+            client.companies.find(company.id).name.should == "new"
+          end
+        end
+      end
+
+      context "with an invalid model" do
+        before { company.name = nil }
+
+        context "when saved" do
+          it "raises an error" do
+            expect { company.save }.to raise_error PipeLineDealer::Error::Connection::Unprocessable
+          end
+        end
+      end
+    end
+  end
+end

data/spec/acceptance/people/creation_spec.rb

@@ -0,0 +1,19 @@
+require "helper"
+
+describe "Person", :acceptance do
+  describe "creation" do
+    include AcceptanceHelper
+
+    context "using client.people.new" do
+      let(:person) { client.people.new(first_name: "Maarten", last_name: "Hoogendoorn") }
+
+      before { person.first_name = "MoreTea" }
+
+      context "when saved" do
+        it "returns a model" do
+          person.save.should be_kind_of PLD::Model::Base
+        end
+      end
+    end
+  end
+end

data/spec/collection_spec.rb

@@ -0,0 +1,166 @@
+require "helper"
+
+describe PLD::Collection do
+  include ConnectionHelper
+
+  subject { PLD::Collection.new(client, klass: TestModel) }
+
+  context "transparant pagination" do
+    let(:expected_params_a) { ["test_models.json", { page: 1, per_page: 200 } ] }
+    let(:expected_params_b) { ["test_models.json", { page: 2, per_page: 200 } ] }
+
+    let(:response_a) do
+      [
+        200, # Status code
+        {    # 'JSON' body
+          "pagination" => {
+            "page"      => 1,
+            "pages"     => 2,
+            "per_page"  => 1,
+            "total"     => 2,
+            "url"       => '/resource',
+          },
+          "entries" => [model_a.attributes]
+        }
+      ]
+    end
+
+    let(:response_b) do
+      [
+        200, # Status code
+        {    # 'JSON' body
+          "pagination" => {
+            "page"      => 2,
+            "pages"     => 2,
+            "per_page"  => 1,
+            "total"     => 2,
+            "url"       => '/resource',
+          },
+          "entries" => [model_b.attributes]
+        }
+      ]
+    end
+
+    let(:model_a) { TestModel.new(collection: subject, attributes: { name: "Maarten" }) }
+    let(:model_b) { TestModel.new(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)
+      connection.should_receive(:get).ordered.once.with(*expected_params_b).and_return(response_b)
+
+      subject.all.to_a.should =~ [model_a, model_b]
+    end
+
+    it "returns records that are not new" do
+      connection.should_receive(:get).ordered.once.with(*expected_params_a).and_return(response_a)
+      connection.should_receive(:get).ordered.once.with(*expected_params_b).and_return(response_b)
+
+      a, b = subject.all.to_a
+
+      a.new_record?.should == false
+      b.new_record?.should == false
+    end
+  end
+
+  context "limit" do
+    let(:expected_params) { ["test_models.json", { page:1, per_page: 1} ] }
+
+    let(:response) do
+      [
+        200, # Status code
+        {    # 'JSON' body
+          "pagination" => {
+             "page"      => 1,
+             "pages"     => 2,
+             "per_page"  => 1,
+             "total"     => 2,
+             "url"       => '/resource',
+           },
+          "entries" => [model_a.attributes]
+        }
+      ]
+    end
+
+    let(:model_a) { TestModel.new(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)
+      subject.first.should == model_a
+    end
+  end
+
+  describe "cacheing" do
+    let(:response) do
+      [
+        200, # Status code
+        {
+          "pagination" => {
+             "page"      => 1,
+             "pages"     => 1,
+             "per_page"  => 1,
+             "total"     => 1,
+             "url"       => '/resource',
+           },
+          "entries" => [{}]
+        }
+      ]
+    end
+
+    before do
+      connection.stub(:get).and_return(response)
+    end
+
+    context "not cached" do
+      subject { PLD::Collection.new(client, klass: TestModel, cached: false) }
+
+      it "doesn't try to cache the result" do
+        connection.should_not_receive(:cache)
+        subject.all.to_a
+      end
+    end
+
+    context "cached" do
+      subject { PLD::Collection.new(client, klass: TestModel, cached: true) }
+
+      it "caches the request" do
+        connection.should_receive(:cache)
+        subject.all
+      end
+    end
+  end
+
+  context "building new objects" do
+    let(:new_object) { subject.new }
+
+    it "builds a model" do
+      new_object.should be_kind_of TestModel
+    end
+
+    context "initialize these objects" do
+      include CollectionHelper
+      subject { collection }
+
+      context "valid attributes" do
+        it "sets the valid attributes" do
+          model = collection.new(name: "Springest")
+          model.name.should == "Springest"
+        end
+      end
+
+      context "invalid attributes" do
+        context "invalid name" do
+          it "raises an exception" do
+            expect { collection.new(no_such_name: "Springest") }.to raise_error(PLD::Error::InvalidAttributeName)
+          end
+        end
+
+        context "invalid value" do
+          it "raises an exception" do
+            pending "TODO"
+            expect { collection.new(name: "Springest") }.to raise_error(PLD::Error::InvalidAttributeValue)
+          end
+        end
+      end
+    end
+  end
+end