pipejump 0.2.0

data/lib/pipejump/resources/source.rb

@@ -0,0 +1,159 @@
+module Pipejump
+
+  # The Sources resource is represented by an instance of Pipejump::Source.
+  # 
+  # *Note*: To access any resources, you need a valid Session instance, referred to as @session in the following examples.
+  # 
+  # == Access
+  # 
+  # === Collection
+  # 
+  # To fetch a collection of Pipejump::Source instances, call
+  # 
+  # 
+  #      @session.sources 
+  #      # => #<Pipejump::Collection resource: Pipejump::Source>
+  # 
+  # 
+  # This returns a Pipejump::Collection instance. To retrieve an array of Pipejump::Source instances, call the _all_ method on the collection:
+  # 
+  # 
+  #      @session.sources.all 
+  #      # => [#<Pipejump::Source name: "My Source", id: "1">, #<Pipejump::Source name: "Another Source", id: "2">]
+  # 
+  # 
+  # Instead of _all_, you can also call a variety of Array methods in the collection which will be delegated to the array returned by _all_, such as:
+  # 
+  # * first
+  # * last
+  # * each
+  # * size
+  # * collect
+  # * reject
+  # 
+  # *Examples*:
+  # 
+  #      @session.sources.first 
+  #      # => #<Pipejump::Source name: "My Source", id: "1">
+  #      @session.sources.last 
+  #      # => #<Pipejump::Source name: "Another Source", id: "2">
+  #      @session.sources.size
+  #      # => 2
+  #      @session.sources.each { |source| puts source.name } 
+  #      # Prints out "My Source" and "Another Source"
+  #      @session.sources.collect { |source| source.name } 
+  #      # => ["My Source",  "Another Source"]
+  #      @session.sources.reject { |source| source.name == 'My Source' } 
+  #      # => ["My Source",  "Another Source"]
+  # 
+  # 
+  # === Resource
+  # 
+  # To fetch a single resource, call the _find_ method with the resource id as an argument:
+  # 
+  # 
+  #      @session.sources.find(1) 
+  #      # => #<Pipejump::Source name: "My Source", id: "1">
+  # 
+  # 
+  # == Creation
+  # 
+  # *Note*: Sources require the following fields in the hash of attributes:
+  # 
+  # * _name_: a valid name
+  # 
+  # To create a new source, call the _create_ method on the Source Pipejump::Collection with a hash of attributes as an argument:
+  # 
+  # 
+  #      @session.sources.create(:name => 'Third Source') 
+  #      # => #<Pipejump::Source name: "Third Source", id: "3">
+  # 
+  # 
+  # If the resource was created properly, it will be returned with a id assigned to it. You can check it by calling the created? method
+  # 
+  # 
+  #      source = @session.sources.create(:name => 'Third Source') 
+  #      # => #<Pipejump::Source name: "Third Source", id: "3">
+  #      source.created? 
+  #      # => true
+  #      source = @session.sources.create(:name => '') 
+  #      # => #<Pipejump::Source name: "">
+  #      source.created? 
+  #      # => false
+  # 
+  # 
+  # You can access validation/creation errors by calling the _errors_ method on the instance returned by _create_:
+  # 
+  # 
+  #      source = @session.sources.create(:name => '') 
+  #      # => #<Pipejump::Source name: "">
+  #      source.created? 
+  #      # => false
+  #      source.errors 
+  #      # => {"source"=>[{"error"=>{"code"=>"E0001", "field"=>"name", "description"=>"can't be blank"}}]}
+  # 
+  # 
+  # == Update
+  # 
+  # To update a resource, change the attributes and call the _save_ method.
+  # 
+  # === Changing attributes
+  # 
+  # Each attribute has an accessor which you can use to change the values:
+  # 
+  # 
+  #      source = @session.sources.create(:name => 'Third Source') 
+  #      # => #<Pipejump::Source name: "Third Source", id: "3">
+  #      source.name 
+  #      # => 'Third Source'
+  #      source.name = 'Super Source' 
+  #      # => 'Super Source'
+  #      source.name 
+  #      # => 'Super Source'
+  # 
+  # 
+  # === Saving
+  # 
+  # Once you've changed the attributes, call the _save_ method on the resource instance:
+  # 
+  # 
+  #      source = @session.sources.create(:name => 'Third Source') 
+  #      # => #<Pipejump::Source name: "Third Source", id: "3">
+  #      source.name 
+  #      # => 'Third Source'
+  #      source.save
+  #      # => true
+  # 
+  # 
+  # _save_ returns _true_ if save was successful and _false_ if it failed. In the latter scenario, you can access the errors via the _errors_ method:
+  # 
+  # 
+  #      source = @session.sources.create(:name => 'Third Source') 
+  #      # => #<Pipejump::Source name: "Third Source", id: "3">
+  #      source.name = 'Super Source'
+  #      # => 'Super Source'
+  #      source.save 
+  #      # => true
+  #      source.name = '' 
+  #      # => ''
+  #      source.save 
+  #      # => false
+  #      source.errors 
+  #      # => {"source"=>[{"error"=>{"code"=>"E0001", "field"=>"name", "description"=>"can't be blank"}}]}
+  # 
+  # 
+  # == Removal
+  # 
+  # To remove a resource, call the _destroy_ method on the instance:
+  # 
+  # 
+  #      source = @session.sources.find(1) 
+  #      #  => #<Pipejump::Source name: "My Source", id: "1">
+  #      source.destroy 
+  #      # => true
+  # 
+  
+  class Source < Resource
+  end
+  
+end

data/lib/pipejump.rb

@@ -0,0 +1,19 @@
+require 'json'
+require 'net/http'
+require 'net/https'
+module Pipejump #:nodoc: 
+end
+
+require 'pipejump/base/collection'
+require 'pipejump/base/resource'
+require 'pipejump/base/session'
+require 'pipejump/base/errors'
+require 'pipejump/base/connection'
+
+require 'pipejump/resources/account'
+require 'pipejump/resources/deal'
+require 'pipejump/resources/note'
+require 'pipejump/resources/reminder'
+require 'pipejump/resources/source'
+require 'pipejump/resources/client'
+require 'pipejump/resources/contact'

data/spec/connection.sample.yml

@@ -0,0 +1,3 @@
+endpoint: TEST_API_SERVER
+email: YOUR_EMAIL
+password: YOUR_PASSWORD

data/spec/pipejump/resources/client_spec.rb

@@ -0,0 +1,119 @@
+require 'spec/spec_helper'
+describe Pipejump::Client do
+
+  before do 
+    @session = PipejumpSpec.session
+    @client1 = @session.clients.create(:name => 'Client1')
+    @client1.id.should_not be_nil
+    @client2 = @session.clients.create(:name => 'Client2')
+    @client2.id.should_not be_nil
+  end
+  
+  after do
+    @client1.destroy
+    @client2.destroy
+  end
+  
+  describe '@session.clients' do
+    
+    it ".all should return all clients" do
+      @session.clients.all.collect(&:name).should == [@client1, @client2].collect(&:name) 
+    end
+
+    it ".first should return first client" do
+      @session.clients.first.name.should == @client1.name
+    end
+
+    it ".last should return last client" do
+      @session.clients.last.name.should == @client2.name
+    end
+    
+    it ".find should find exact client" do
+      @session.clients.find(@client1.id).name.should == @client1.name
+    end
+    
+  end  
+  
+  describe '#method_missing' do
+    
+    it "should correctly get and set attributes" do 
+      @client1.attributes.keys.sort.should == ['id', 'name']
+      @client1.attributes.keys.each do |attribute|
+        @client1.send(attribute).should == @client1.attributes[attribute]
+      end
+      @client1.name = 'Different name'
+      @client1.name.should == 'Different name'
+      @client1.attributes['name'].should == 'Different name'
+    end
+    
+    it "should raise a NoMethodError when no accessor is set" do
+      lambda {
+        @client1.not_a_method_name
+      }.should raise_error(NoMethodError)
+    end
+ 
+  end
+
+  describe '#create' do
+    
+    it "should create record" do
+      @client3 = @session.clients.create(:name => 'Client3')
+      @client3.id.should_not be_nil
+      @client3.name.should == 'Client3'
+      @session.clients.find(@client3.id).name.should == 'Client3'
+      @client3.destroy
+    end
+    
+    it "should return error on validation fail" do
+      @client3 = @session.clients.create(:name => '')
+      @client3.id.should be_nil
+      @client3.errors.should_not == {}      
+    end
+    
+  end
+
+  describe '#update' do
+    
+    it "should update record" do
+      @client1.name = 'Different name'
+      @client1.save.should == true
+      @session.clients.find(@client1.id).name.should == 'Different name'
+    end
+    
+    it "should return error on validation fail" do
+      @client1.name = ''
+      @client1.save.should == false
+      @client1.errors.should_not == {}      
+    end
+    
+  end
+  
+  describe '#contacts' do
+    
+    before do
+      @contact1 = @session.contacts.create(:name => 'contact1', :client_id => @client1.id)
+      @contact2 = @session.contacts.create(:name => 'contact2', :client_id => @client1.id)
+    end
+    
+    describe '#all' do
+      
+      it "should return contacts of a client" do
+        contacts = @client1.contacts
+        contacts.size.should == 2
+        contacts.collect(&:name).should == ['contact1', 'contact2']
+      end
+
+    end
+
+    describe '#find' do
+      
+      it "should return a single contact of a client" do
+        contact = @client1.contacts.find(@contact1.id)
+        contact.name == 'contact1'
+      end
+    
+    end
+    
+  end
+
+end

data/spec/pipejump/resources/contact_spec.rb

@@ -0,0 +1,93 @@
+require 'spec/spec_helper'
+describe Pipejump::Contact do
+
+  before do 
+    @session = PipejumpSpec.session
+    @client = @session.clients.create(:name => 'Client1')
+    @contact1 = @session.contacts.create(:name => 'contact1', :client_id => @client.id)
+    @contact1.id.should_not be_nil
+    @contact2 = @session.contacts.create(:name => 'contact2', :client_id => @client.id)
+    @contact2.id.should_not be_nil
+  end
+  
+  after do
+    @client.destroy
+    @contact1.destroy
+    @contact2.destroy
+  end
+  
+  describe '@session.contacts' do
+    
+    it ".all should return all contacts" do
+      @session.contacts.all.collect(&:name).should == [@contact1, @contact2].collect(&:name) 
+    end
+
+    it ".first should return first contact" do
+      @session.contacts.first.name.should == @contact1.name
+    end
+
+    it ".last should return last contact" do
+      @session.contacts.last.name.should == @contact2.name
+    end
+    
+    it ".find should find exact contact" do
+      @session.contacts.find(@contact1.id).name.should == @contact1.name
+    end
+    
+  end  
+  
+  describe '#method_missing' do
+    
+    it "should correctly get and set attributes" do 
+      @contact1.attributes.keys.sort.should == ["client_id", "email", "id", "mobile", "name", "phone"] 
+      @contact1.attributes.keys.each do |attribute|
+        @contact1.send(attribute).should == @contact1.attributes[attribute]
+      end
+      @contact1.name = 'Different name'
+      @contact1.name.should == 'Different name'
+      @contact1.attributes['name'].should == 'Different name'
+    end
+    
+    it "should raise a NoMethodError when no accessor is set" do
+      lambda {
+        @contact1.not_a_method_name
+      }.should raise_error(NoMethodError)
+    end
+ 
+  end
+
+  describe '#create' do
+    
+    it "should create record" do
+      @contact3 = @session.contacts.create(:name => 'contact3', :client_id => @client.id)
+      @contact3.id.should_not be_nil
+      @contact3.name.should == 'contact3'
+      @session.contacts.find(@contact3.id).name.should == 'contact3'
+      @contact3.destroy
+    end
+    
+    it "should return error on validation fail" do
+      @contact3 = @session.contacts.create(:name => '')
+      @contact3.id.should be_nil
+      @contact3.errors.should_not == {}      
+    end
+    
+  end
+
+  describe '#update' do
+    
+    it "should update record" do
+      @contact1.name = 'Different name'
+      @contact1.save.should == true
+      @session.contacts.find(@contact1.id).name.should == 'Different name'
+    end
+    
+    it "should return error on validation fail" do
+      @contact1.name = ''
+      @contact1.save.should == false
+      @contact1.errors.should_not == {}      
+    end
+    
+  end
+
+end

data/spec/pipejump/resources/deal_spec.rb

@@ -0,0 +1,115 @@
+require 'spec/spec_helper'
+describe Pipejump::Deal do
+
+  before do 
+    @session = PipejumpSpec.session
+    @client = @session.clients.create(:name => 'Client1')
+  end
+  
+  after do
+    @client.destroy
+  end
+  
+  describe '#create' do
+    
+    it "should create deal with valid params" do
+      @deal = @session.deals.create(:name => 'New deal', :client_id => @client.id)
+      @deal.attributes.keys.sort.should == ["client", "client_id", "deal_tags", "hot", "id", "name", "scope", "stage_name"] 
+      (@deal.attributes.keys - ['client']).each do |attribute|
+        @deal.send(attribute).should == @deal.attributes[attribute]
+      end
+      @deal.client.class.should == Pipejump::Client
+      @deal.destroy
+    end
+    
+    it "should return errors with invalid params" do
+      @deal = @session.deals.create({})
+      @deal.id.should == nil
+      @deal.errors['deal'].collect{ |e| e['error']['field'] }.sort.should == ['client', 'name']
+    end
+    
+  end
+  
+  describe '.find' do
+
+    it "should find deal" do
+      @deal = @session.deals.create(:name => 'New deal', :client_id => @client.id)
+      @found = @session.deals.find(@deal.id)
+      @found.name == @deal.name
+      @deal.destroy
+    end
+      
+    it "should raise error if not found" do
+      lambda {
+        @session.deals.find(-1)
+      }.should raise_error(Pipejump::ResourceNotFound)
+    end
+  end
+  
+  describe '#update' do
+   
+    before do
+      @deal = @session.deals.create(:name => 'New deal', :client_id => @client.id)
+    end
+    
+    after do 
+      @deal.destroy
+    end 
+    
+    it "should update deal with valid params" do
+      @deal.name = 'Updated deal'
+      @deal.save
+      @deal.save.should == true
+      @found = @session.deals.find(@deal.id)
+      @found.name.should == 'Updated deal'
+    end
+    
+    it "should return errors with invalid params" do
+      @deal.name = ''
+      @deal.save.should == false      
+      @deal.errors['deal'].collect{ |e| e['error']['field'] }.sort.should == ['name']
+    end
+    
+  end
+  
+  describe '#contacts' do
+    
+    before do 
+      @deal = @session.deals.create(:name => 'New deal', :client_id => @client.id)
+      @contact = @session.contacts.create(:name => 'Tom', :client_id => @client.id)
+      @contact2 = @session.contacts.create(:name => 'Mike', :client_id => @client.id)
+      @deal.contacts.update(@contact.id).should == true
+    end
+    
+    after do
+      @contact.destroy
+      @contact2.destroy
+    end
+    
+    it "should return a collection of contacts" do
+      contacts = @deal.contacts
+      contacts.class.should == Pipejump::Collection
+      contacts.respond_to?(:update).should == true
+      contacts.size.should == 1
+    end
+    
+    describe '#update' do
+      
+      it "should update a collection of contacts and be smart about it" do
+        @deal.contacts.update([@contact.id, @contact2.id])
+        @deal.contacts.size.should == 2
+        @deal.contacts.update([@contact])
+        @deal.contacts.size.should == 1
+        @deal.contacts.update([@contact.id, @contact2])
+        @deal.contacts.size.should == 2
+        @deal.contacts.update([@contact2.id])
+        @deal.contacts.size.should == 1
+        @deal.contacts.update([@contact.id, @contact2.id].join(','))
+        @deal.contacts.size.should == 2
+      end
+      
+    end
+    
+  end
+  
+end

data/spec/pipejump/resources/note_spec.rb

@@ -0,0 +1,100 @@
+require 'spec/spec_helper'
+describe Pipejump::Note do
+  
+  before do 
+    @session = PipejumpSpec.session
+    @client = @session.clients.create(:name => 'Client1')
+    @deal = @session.deals.create(:name => 'New deal', :client_id => @client.id)
+  end
+
+  after do
+    @client.destroy
+  end
+
+  describe '#all' do
+  
+    before do
+      @note = @deal.notes.create(:content => 'Some note')
+    end
+    
+    after do
+      @note.destroy
+    end
+    
+    it "should fetch notes within a deal" do
+      @deal.notes.size.should == 1
+      @deal.notes.first.content.should == 'Some note'
+    end
+
+  end
+  
+  describe '#find' do
+
+    it "should fetch notes within a deal" do
+      @note = @deal.notes.create(:content => 'Some note')
+      @found = @deal.notes.find(@note.id)
+      @found.content.should == 'Some note'
+    end
+
+    it "should raise an error if not found" do
+      lambda {
+        @deal.notes.find(-1)
+      }.should raise_error(Pipejump::ResourceNotFound)
+    end
+    
+  end
+  
+  describe '#create' do
+    
+    it "should create note with valid params" do
+      @note = @deal.notes.create(:content => 'Some note')
+      @note.attributes.keys.sort.should == ["content", "id", "username"]
+      @note.destroy
+    end
+    
+    it "should not create note with invalid params" do
+      @note = @deal.notes.create(:content => '')
+      @note.errors['note'].collect{ |e| e['error']['field'] }.sort.should == ['content']
+    end
+    
+  end
+  
+  describe '#update' do
+    
+    before do
+      @note = @deal.notes.create(:content => 'Some note')
+    end
+    
+    after do
+      @note.destroy
+    end
+    
+    it "should update note with valid params" do
+      @note.content = 'Updated note'
+      @note.save.should == true
+      @deal.notes.find(@note.id).content.should == 'Updated note'
+    end
+    
+    it "should not update note with invalid params" do
+      @note.content = ''
+      @note.save.should == false
+      @note.errors['note'].collect{ |e| e['error']['field'] }.sort.should == ['content']  
+    end
+    
+  end
+  
+  describe '#destroy' do
+    
+    it "should destroy a note" do
+      @note = @deal.notes.create(:content => 'Some note')
+      @note.destroy.should == true
+      lambda {
+        @deal.notes.find(@note.id)
+      }.should raise_error(Pipejump::ResourceNotFound)
+      
+    end
+
+  end
+        
+end
+