pipejump 0.2.0 → 0.3.0

data/lib/pipejump/resources/deal.rb

@@ -1,213 +1,213 @@
 module Pipejump
-  
+
   # A Deal is represented by an instance of Pipejump::Deal.
-  # 
+  #
   # *Note*: To access any deals, you need a valid Session instance, referred to as @session in the following examples.
-  # 
+  #
   # == Access
-  # 
+  #
   # === Collection
-  # 
+  #
   # To fetch a collection of Pipejump::Deal instances, call
-  # 
-  # 
-  #      @session.deals 
+  #
+  #
+  #      @session.deals
   #      # => #<Pipejump::Collection resource: Pipejump::Deal>
-  # 
-  # 
+  #
+  #
   # This returns a Pipejump::Collection instance. To retrieve an array of Pipejump::Deal instances, call the _all_ method on the collection:
-  # 
-  # 
-  #      @session.deals.all 
-  #      # => [#<Pipejump::Deal name: "Good Deal", scope: "0", hot: "false", stage_name: "incoming", deal_tags: "", id: "1">, 
+  #
+  #
+  #      @session.deals.all
+  #      # => [#<Pipejump::Deal name: "Good Deal", scope: "0", hot: "false", stage_name: "incoming", deal_tags: "", id: "1">,
   #      #     #<Pipejump::Deal name: "Ok Deal", scope: "0", hot: "false", stage_name: "incoming", deal_tags: "", 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.deals.first 
+  #
+  #      @session.deals.first
   #      # => #<Pipejump::Deal name: "Good Deal", scope: "0", hot: "false", stage_name: "incoming", deal_tags: "", id: "1">
-  #      @session.deals.last 
+  #      @session.deals.last
   #      # => #<Pipejump::Deal name: "Ok Deal", scope: "0", hot: "false", stage_name: "incoming", deal_tags: "", id: "2">
   #      @session.deals.size
   #      # => 2
-  #      @session.deals.each { |deal| puts deal.name } 
+  #      @session.deals.each { |deal| puts deal.name }
   #      # Prints out "Good Deal" and "Ok Deal"
-  #      @session.deals.collect { |deal| deal.name } 
+  #      @session.deals.collect { |deal| deal.name }
   #      # => ["Good Deal",  "Ok Deal"]
-  #      @session.deals.reject { |deal| deal.name == 'Good Deal' } 
+  #      @session.deals.reject { |deal| deal.name == 'Good Deal' }
   #      # => ["Ok Deal"]
-  # 
-  # 
+  #
+  #
   # === Resource
-  # 
+  #
   # To fetch a single deal, call the _find_ method with the deal id as an argument:
-  # 
-  # 
-  #      @session.deals.find(1) 
+  #
+  #
+  #      @session.deals.find(1)
   #      # => #<Pipejump::Deal name: "Good Deal", scope: "0", hot: "false", stage_name: "incoming", deal_tags: "", id: "1">
-  # 
-  # 
+  #
+  #
   # == Creation
-  # 
+  #
   # *Note*: Deals require the following fields in the hash of attributes:
-  # 
+  #
   # * _name_: a valid name
-  # * _client_id_: a valid a Client id 
-  # 
-  # To create a new deal, call the _create_ method on the Deal Pipejump::Collection with a hash of attributes as an argument. 
-  # 
-  # 
-  #      @session.deals.create(:name => 'Great Deal', :client_id => 1) 
+  # * _client_id_: a valid a Client id
+  #
+  # To create a new deal, call the _create_ method on the Deal Pipejump::Collection with a hash of attributes as an argument.
+  #
+  #
+  #      @session.deals.create(:name => 'Great Deal', :client_id => 1)
   #      # => #<Pipejump::Deal name: "Great Deal", scope: "0", hot: "false", stage_name: "incoming", deal_tags: "", id: "3">
-  # 
-  # 
+  #
+  #
   # If the deal was created properly, it will be returned with a id assigned to it. You can check it by calling the created? method
-  # 
-  # 
-  #      deal = @session.deals.create(:name => 'Great Deal', :client_id => 1) 
+  #
+  #
+  #      deal = @session.deals.create(:name => 'Great Deal', :client_id => 1)
   #      # => #<Pipejump::Deal name: "Great Deal", scope: "0", hot: "false", stage_name: "incoming", deal_tags: "", id: "3">
-  #      deal.created? 
+  #      deal.created?
   #      # => true
-  #      deal = @session.deals.create(:name => '') 
+  #      deal = @session.deals.create(:name => '')
   #      # => #<Pipejump::Deal name: "">
-  #      deal.created? 
+  #      deal.created?
   #      # => false
-  # 
-  # 
+  #
+  #
   # You can access validation/creation errors by calling the _errors_ method on the instance returned by _create_:
-  # 
-  # 
-  #      deal = @session.deals.create(:name => '') 
+  #
+  #
+  #      deal = @session.deals.create(:name => '')
   #      # => #<Pipejump::Deal name: "">
-  #      deal.created? 
+  #      deal.created?
   #      # => false
-  #      deal.errors 
-  #      # => {"deal"=>[{"error"=>{"code"=>"E0001", "field"=>"name", "description"=>"Please enter a deal name"}}, 
+  #      deal.errors
+  #      # => {"deal"=>[{"error"=>{"code"=>"E0001", "field"=>"name", "description"=>"Please enter a deal name"}},
   #      #    {"error"=>{"code"=>"E0001", "field"=>"client", "description"=>"Please enter a valid client id"}}]}
-  # 
-  # 
+  #
+  #
   # == Update
-  # 
+  #
   # To update a deal, change the attributes and call the _save_ method.
-  # 
+  #
   # === Changing attributes
-  # 
+  #
   # Each attribute has an accessor which you can use to change the values:
-  # 
-  # 
-  #      deal = @session.deals.create(:name => 'Great Deal', :client_id => 1) 
+  #
+  #
+  #      deal = @session.deals.create(:name => 'Great Deal', :client_id => 1)
   #      # => #<Pipejump::Deal name: "Great Deal", scope: "0", hot: "false", stage_name: "incoming", deal_tags: "", id: "3">
-  #      deal.name 
+  #      deal.name
   #      # => 'Great Deal'
-  #      deal.name = 'Super Deal' 
+  #      deal.name = 'Super Deal'
   #      # => 'Super Deal'
-  #      deal.name 
+  #      deal.name
   #      # => 'Super Deal'
-  # 
-  # 
+  #
+  #
   # === Saving
-  # 
+  #
   # Once you've changed the attributes, call the _save_ method on the deal instance:
-  # 
-  # 
-  #      deal = @session.deals.create(:name => 'Great Deal', :client_id => 1) 
+  #
+  #
+  #      deal = @session.deals.create(:name => 'Great Deal', :client_id => 1)
   #      # => #<Pipejump::Deal name: "Great Deal", scope: "0", hot: "false", stage_name: "incoming", deal_tags: "", id: "3">
-  #      deal.name = 'Super Deal' 
+  #      deal.name = 'Super Deal'
   #      # => 'Super Deal'
   #      deal.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:
-  # 
-  # 
-  #      deal = @session.deals.create(:name => 'Great Deal', :client_id => 1) 
+  #
+  #
+  #      deal = @session.deals.create(:name => 'Great Deal', :client_id => 1)
   #      # => #<Pipejump::Deal name: "Great Deal", scope: "0", hot: "false", stage_name: "incoming", deal_tags: "", id: "3">
   #      deal.name = 'Super Deal'
   #      # => 'Super Deal'
-  #      deal.save 
+  #      deal.save
   #      # => true
-  #      deal.name = '' 
+  #      deal.name = ''
   #      # => ''
-  #      deal.save 
+  #      deal.save
   #      # => false
-  #      deal.errors 
+  #      deal.errors
   #      # => {"deal"=>[{"error"=>{"code"=>"E0001", "field"=>"name", "description"=>"Please enter a deal name"}} ]}
-  # 
-  # 
+  #
+  #
   # == Removal
-  # 
+  #
   # You cannot remove a deal, you can move it between stages
-  # 
+  #
   # == Changing stages
-  # 
+  #
   # To change a Deal stage, change the value of the _stage_name_ attribute to one of the following:
-  # 
+  #
   # * incoming
   # * qualified
   # * quote
   # * closure
   # * won
   # * lost
-  # * unqualified 
-  # 
+  # * unqualified
+  #
   # Afterwards, save the deal to update the Deal stage.
-  # 
-  # 
-  #      deal = @session.deals.create(:name => 'Great Deal', :client_id => 1) 
+  #
+  #
+  #      deal = @session.deals.create(:name => 'Great Deal', :client_id => 1)
   #      # => #<Pipejump::Deal name: "Great Deal", scope: "0", hot: "false", stage_name: "incoming", deal_tags: "", id: "3">
   #      deal.stage_name = 'qualified'
   #      # => 'qualified'
   #      deal.save
   #      # => true
-  # 
-  # 
+  #
+  #
   # == Contacts
-  # 
+  #
   # You can access Deal Contacts assigned to a deal by calling _contacts_ on an instance of a Deal:
-  # 
-  # 
+  #
+  #
   #      @deal.contacts
-  # 
-  # 
+  #
+  #
   # For more information, consult the Deal Contacts page.
-  # 
+  #
   # == Notes
-  # 
+  #
   # You can access Notes of a specific deal by calling _notes_ on an instance of a Deal:
-  # 
-  # 
+  #
+  #
   #      @deal.notes
-  # 
-  # 
+  #
+  #
   # For more information, consult the Notes page.
-  # 
+  #
   # == Reminders
-  # 
+  #
   # You can access Reminders of a specific deal by calling _reminders_ on an instance of a Deal:
-  # 
-  # 
+  #
+  #
   #      @deal.reminders
-  # 
-  # 
+  #
+  #
   # For more information, consult the Reminders page.
-  class Deal < Resource 
-    belongs_to :client
+  class Deal < Resource
+    belongs_to :entity, :class_name => 'Contact'
     has_many :contacts do
       disable :find, :create
 
       # Updates the Contact resources assigned to a deal
-      # 
+      #
       # Accepts the following arguments:
       # * String:
       #     @deal.contacts.update('1, 2')
@@ -219,8 +219,8 @@ module Pipejump
       #     @deal.contacts.update([1, @contact2])
       def update(ids) #:nodoc:
         if ids.is_a?(Array)
-          ids = ids.collect { |element| 
-            if element.is_a?(Pipejump::Resource) 
+          ids = ids.collect { |element|
+            if element.is_a?(Pipejump::Resource)
               element.id
             elsif element.is_a?(Fixnum)
               element
@@ -233,14 +233,14 @@ module Pipejump
       end
 
     end
-    
+
     has_many :notes
     has_many :reminders
-        
+
     def to_query #:nodoc:
       @attributes.collect { |pair| pair[0] = "#{pair[0]}"; pair.join('=') }.join('&')
     end
-    
+
   end
-  
+
 end

data/lib/pipejump/resources/reminder.rb

@@ -1,171 +1,174 @@
 module Pipejump
-  
+
   # The Reminders resource is represented by an instance of Pipejump::Reminder.
-  # 
+  #
   # *Reminder*: To access any Reminders, you need a valid Deal instance, referred to as @deal in the following examples. Reminders belong to a deal, so you can only access them via @deal, not the session.
-  # 
+  #
   # == Access
-  # 
+  #
   # === Collection
-  # 
+  #
   # To fetch a collection of Pipejump::Reminder instances, call
-  # 
-  # 
-  #      @deal.reminders 
+  #
+  #
+  #      @deal.reminders
   #      # => #<Pipejump::Collection resource: Pipejump::Reminder, owner: #<Pipejump::Deal name: "My Deal", scope: "0", hot: "false", stage_name: "incoming", id: "1", deal_tags: "">>
-  # 
-  # 
+  #
+  #
   # This returns a Pipejump::Collection instance. To retrieve an array of Pipejump::Reminder instances, call the _all_ method on the collection:
-  # 
-  # 
-  #      @deal.reminders.all 
+  #
+  #
+  #      @deal.reminders.all
   #      # => [#<Pipejump::Reminder done: "false", time: "14:00", id: "1", date: "2010-11-11", content: "My Reminder">,
   #      #     #<Pipejump::Reminder done: "false", time: "16:00", id: "2", date: "2010-11-11", content: "Another Reminder">]
-  # 
-  # 
+  #
+  #
   # 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*:
-  # 
-  #      @deal.reminders.first 
+  #
+  #      @deal.reminders.first
   #      # => #<Pipejump::Reminder done: "false", time: "14:00", id: "1", date: "2010-11-11", content: "My Reminder">
-  #      @deal.reminders.last 
+  #      @deal.reminders.last
   #      # => #<Pipejump::Reminder done: "false", time: "16:00", id: "2", date: "2010-11-11", content: "Another Reminder">
   #      @deal.reminders.size
   #      # => 2
-  #      @deal.reminders.each { |reminder| puts reminder.content } 
+  #      @deal.reminders.each { |reminder| puts reminder.content }
   #      # Prints out "My Reminder" and "Another Reminder"
-  #      @deal.reminders.collect { |reminder| reminder.content } 
+  #      @deal.reminders.collect { |reminder| reminder.content }
   #      # => ["My Reminder",  "Another Reminder"]
-  #      @deal.reminders.reject { |reminder| reminder.content == 'My Reminder' } 
+  #      @deal.reminders.reject { |reminder| reminder.content == 'My Reminder' }
   #      # => ["Another Reminder"]
-  # 
-  # 
+  #
+  #
   # === Resource
-  # 
+  #
   # To fetch a single resource, call the _find_ method with the resource id as an argument:
-  # 
-  # 
-  #      @deal.reminders.find(1) 
+  #
+  #
+  #      @deal.reminders.find(1)
   #      # => #<Pipejump::Reminder done: "false", time: "14:00", id: "1", date: "2010-11-11", content: "My Reminder">
-  # 
-  # 
+  #
+  #
   # == Creation
-  # 
+  #
   # *Reminder*: Reminders require the following fields in the hash of attributes:
-  # 
+  #
   # * _content_: Reminder content
   # * _date_: Date for the Reminder (ex. 2010-11-11)
   # * _time_: Time for the Reminder (ex. 14:00)
-  # 
+  #
   # To create a new reminder, call the _create_ method on the Reminder Pipejump::Collection with a hash of attributes as an argument:
-  # 
-  # 
-  #      @deal.reminders.create(:content => 'Third Reminder', :date => '2010-11-11', :time => '19:00'}) 
+  #
+  #
+  #      @deal.reminders.create(:content => 'Third Reminder', :date => '2010-11-11', :time => '19:00'})
   #      # => #<Pipejump::Reminder done: "false", time: "19:00", id: "3", date: "2010-11-11", content: "Third Reminder">
-  # 
-  # 
+  #
+  #
   # 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
-  # 
-  # 
-  #      reminder = @deal.reminders.create(:content => 'Third Reminder', :date => '2010-11-11', :time => '19:00'}) 
+  #
+  #
+  #      reminder = @deal.reminders.create(:content => 'Third Reminder', :date => '2010-11-11', :time => '19:00'})
   #      # => #<Pipejump::Reminder done: "false", time: "19:00", id: "3", date: "2010-11-11", content: "Third Reminder">
-  #      reminder.created? 
+  #      reminder.created?
   #      # => true
-  #      reminder = @deal.reminders.create(:content => '') 
+  #      reminder = @deal.reminders.create(:content => '')
   #      # => #<Pipejump::Reminder content: "">
-  #      reminder.created? 
+  #      reminder.created?
   #      # => false
-  # 
-  # 
+  #
+  #
   # You can access validation/creation errors by calling the _errors_ method on the instance returned by _create_:
-  # 
-  # 
-  #      reminder = @deal.reminders.create(:content => '') 
+  #
+  #
+  #      reminder = @deal.reminders.create(:content => '')
   #      # => #<Pipejump::Reminder content: "">
-  #      reminder.created? 
+  #      reminder.created?
   #      # => false
-  #      reminder.errors 
-  #      # => {"reminder"=>[{"error"=>{"code"=>"E0000", "field"=>"time", "description"=>"The time and date must be in the future"}}, 
-  #      #    {"error"=>{"code"=>"E0001", "field"=>"date", "description"=>"The time and date must be in the future"}}, 
+  #      reminder.errors
+  #      # => {"reminder"=>[{"error"=>{"code"=>"E0000", "field"=>"time", "description"=>"The time and date must be in the future"}},
+  #      #    {"error"=>{"code"=>"E0001", "field"=>"date", "description"=>"The time and date must be in the future"}},
   #      #    {"error"=>{"code"=>"E0001", "field"=>"content", "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:
-  # 
-  # 
-  #      reminder = @deal.reminders.create(:content => 'Third Reminder', :date => '2010-11-11', :time => '19:00'}) 
+  #
+  #
+  #      reminder = @deal.reminders.create(:content => 'Third Reminder', :date => '2010-11-11', :time => '19:00'})
   #      # => #<Pipejump::Reminder done: "false", time: "19:00", id: "3", date: "2010-11-11", content: "Third Reminder">
-  #      reminder.content 
+  #      reminder.content
   #      # => 'Third Reminder'
-  #      reminder.content = 'Super Reminder' 
+  #      reminder.content = 'Super Reminder'
   #      # => 'Super Reminder'
-  #      reminder.content 
+  #      reminder.content
   #      # => 'Super Reminder'
-  # 
-  # 
+  #
+  #
   # === Saving
-  # 
+  #
   # Once you've changed the attributes, call the _save_ method on the resource instance:
-  # 
-  # 
-  #      reminder = @deal.reminders.create(:content => 'Third Reminder', :date => '2010-11-11', :time => '19:00'}) 
+  #
+  #
+  #      reminder = @deal.reminders.create(:content => 'Third Reminder', :date => '2010-11-11', :time => '19:00'})
   #      # => #<Pipejump::Reminder done: "false", time: "19:00", id: "3", date: "2010-11-11", content: "Third Reminder">
-  #      reminder.content 
+  #      reminder.content
   #      # => 'Third Reminder'
   #      reminder.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:
-  # 
-  # 
-  #      reminder = @deal.reminders.create(:content => 'Third Reminder', :date => '2010-11-11', :time => '19:00'}) 
+  #
+  #
+  #      reminder = @deal.reminders.create(:content => 'Third Reminder', :date => '2010-11-11', :time => '19:00'})
   #      # => #<Pipejump::Reminder done: "false", time: "19:00", id: "3", date: "2010-11-11", content: "Third Reminder">
   #      reminder.content = 'Super Reminder'
   #      # => 'Super Reminder'
-  #      reminder.save 
+  #      reminder.save
   #      # => true
-  #      reminder.content = '' 
+  #      reminder.content = ''
   #      # => ''
-  #      reminder.save 
+  #      reminder.save
   #      # => false
-  #      reminder.errors 
+  #      reminder.errors
   #      # => {"reminder"=>[{"error"=>{"code"=>"E0001", "field"=>"content", "description"=>"can't be blank"}}]}
-  # 
-  # 
+  #
+  #
   # == Removal
-  # 
+  #
   # To remove a resource, call the _destroy_ method on the instance:
-  # 
-  # 
-  #      reminder = @deal.reminders.find(1) 
+  #
+  #
+  #      reminder = @deal.reminders.find(1)
   #      #  => #<Pipejump::Reminder content: "My Reminder", id: "1">
-  #      reminder.destroy 
+  #      reminder.destroy
   #      # => true
-  # 
+  #
+
+  class Reminder < Resource
 
-  class Reminder < Resource 
-    
     def before_save #:nodoc:
+      # Make sure this attribute is not sent
+      @attributes.delete('send_time_display')
+      @attributes.delete('related_to')
       if @attributes['date'].is_a?(Time)
-        @attributes['date'] = @attributes['date'].strftime('%Y-%m-%d') 
+        @attributes['date'] = @attributes['date'].strftime('%Y-%m-%d')
       end
     end
-    
+
   end
-  
+
 end

data/lib/pipejump/version.rb

@@ -0,0 +1,3 @@
+module Pipejump
+  VERSION = "0.3.0"
+end

data/lib/pipejump.rb

@@ -1,7 +1,7 @@
 require 'json'
 require 'net/http'
 require 'net/https'
-module Pipejump #:nodoc: 
+module Pipejump #:nodoc:
 end
 
 require 'pipejump/base/collection'
@@ -15,5 +15,4 @@ 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/pipejump.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pipejump/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pipejump"
+  s.version     = Pipejump::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Marcin Bunsch"]
+  s.email       = %q{marcin@futuresimple.com}
+  s.homepage    = "http://pipejump.com/api"
+  s.description = %q{Pipejump API Ruby client}
+  s.summary     = %q{Pipejump API Ruby client}
+
+  s.rubyforge_project = "pipejump"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end