batchbook 1.0.3

data/History.txt

@@ -0,0 +1,10 @@
+=== 1.0.0 / 2009-01-02
+
+* 1 major enhancement
+
+  * Birthday!
+
+=== 1.0.2 / 2009-01-08
+
+* allow label/name param to request a specific location/supertag
+* search people/companies by passing :name or :email param to find(:all , :params {:name => 'will'})

data/Manifest.txt

@@ -0,0 +1,5 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/batchbook.rb

data/README.txt

@@ -0,0 +1,128 @@
+= batchbook
+
+http://github.com/batchblue/batchbook
+
+== DESCRIPTION:
+
+Wrapper for BatchBook XML API
+
+== API
+
+API : http://developer.batchblue.com/
+
+== FEATURES/PROBLEMS:
+
+Basic CRUD features for the data in your account: People, Companies, Communications, To-Dos, Deals.  Also custom methods for adding/removing Tags & SuperTags from a record, as well as updating SuperTag data for a particular record.
+
+== TODO:
+
+* Fix supertag creation + deletion
+* Delete location methods for 'Person' & 'Company'
+
+== SYNOPSIS:
+
+require 'batchbook'
+BatchBook.account = 'devo'
+BatchBook.token = 'xyZ'
+
+#In development to test the urls being used:
+ActiveResource::Base.logger = Logger.new(STDOUT)
+
+#also work for company
+search_by_name = BatchBook::Person.find(:all, :params => {:name => 'will larson'} )
+search_by_email = BatchBook::Person.find(:all, :params => {:email => will@batchblue.com})
+
+#Deal requests
+deal_by_email = BatchBook::Deal.find(:all, :params => {:assigned_to => 'eekrause@batchblue.com'})
+deal_by_status = BatchBook::Deal.find(:all, :params => {:status => 'lost'})
+
+#To add/remove a tag
+deal = BatchBook::Deal.find(1)
+deal.add_tag 'some tag'
+deal.remove_tag 'some tag'
+
+#To add/remove a comment
+comment = BatchBook::Comment.new :comment => "It's a lovely day"
+comment.deal = deal
+comment.save
+deal.comments.first.destroy
+
+person = BatchBook::Person.find(5)
+=> #<BatchBook::Person:0x1822c3c @attributes={"company"=>"BatchBlue Software", "title"=>"Software Developer", "id"=>5, "notes"=>nil, "first_name"=>"Will", "last_name"=>"Larson"}, @prefix_options={}>
+
+person.tags
+=> [#<BatchBook::Tag:0x1816f18 @attributes={"name"=>"batchblue", "id"=>2}, @prefix_options={}>]
+
+person.locations
+=> [#<BatchBook::Location:0x17cb7e8 @attributes={"city"=>"Seattle", "postal_code"=>"98101", "cell"=>"123-456-7890", "street_1"=>"123 Main Street", "street_2"=>nil, "country"=>"United States", "id"=>5, "website"=>"www.batchblue.com", "fax"=>nil, "phone"=>nil, "label"=>"work", "state"=>"WA", "email"=>"wlarson@batchblue.com"}, @prefix_options={}>]
+
+person.location 'work'
+=> #<BatchBook::Location:0x17cb7e8 @attributes={"city"=>"Seattle", "postal_code"=>"98101", "cell"=>"123-456-7890", "street_1"=>"123 Main Street", "street_2"=>nil, "country"=>"United States", "id"=>5, "website"=>"www.batchblue.com", "fax"=>nil, "phone"=>nil, "label"=>"work", "state"=>"WA", "email"=>"wlarson@batchblue.com"}, @prefix_options={}>
+
+person.supertags
+=> [#<BatchBook::SuperTag:0x17e5170 @attributes={"name"=>"reference", "id"=>5149}, @prefix_options={}>, #<BatchBook::SuperTag:0x17e515c @attributes={"name"=>"work schedule", "tuesday"=>"8-4", "wednesday"=>"9-5 PST", "thursday"=>"9-5 PST", "id"=>1948, "monday"=>"9-5 PST", "friday"=>"9-5 PST"}, @prefix_options={}>]
+
+person.supertag 'work schedule'
+=> #<BatchBook::SuperTag:0x17c7ea4 @attributes={"name"=>"work schedule", "tuesday"=>"8-4", "wednesday"=>"9-5 PST", "thursday"=>"9-5 PST", "id"=>1948, "monday"=>"9-5 PST", "friday"=>"9-5 PST"}, @prefix_options={}>
+
+company = BatchBook::Company.find(:all, :params =>{:name => 'BatchBlue'}).first
+=> #<BatchBook::Company:0x1762fcc @attributes={"name"=>"BatchBlue Software", "id"=>2, "notes"=>nil}, @prefix_options={}>
+
+company.tags
+=> []
+
+company.supertags
+=> []
+
+company.locations
+=> [#<BatchBook::Location:0x1737cb4 @attributes={"city"=>"Barrington", "postal_code"=>"02806", "cell"=>nil, "street_1"=>"18 Maple Ave.", "street_2"=>"Suite #300", "country"=>"United States", "id"=>622, "website"=>"http://batchblue.com", "fax"=>"(401) 633-6526", "phone"=>"(888) 402-2824", "label"=>"main", "email"=>"info@batchblue.com", "state"=>"RI"}, @prefix_options={}>]
+
+company.location 'main'
+=> #<BatchBook::Location:0x17225bc @attributes={"city"=>"Barrington", "postal_code"=>"02806", "cell"=>nil, "street_1"=>"18 Maple Ave.", "street_2"=>"Suite #300", "country"=>"United States", "id"=>622, "website"=>"http://batchblue.com", "fax"=>"(401) 633-6526", "phone"=>"(888) 402-2824", "label"=>"main", "email"=>"info@batchblue.com", "state"=>"RI"}, @prefix_options={}>
+
+== ADDITIONAL EXAMPLES
+
+person = BatchBook::Person.new(:first_name => 'Test', :last_name => 'Name', :notes => "Created via batchbook API")
+person.save
+
+person.add_tag('some tag name')
+person.remove_tag('some tag name')
+
+person.add_supertag('some tag name', "some field" => "some value")
+
+person.add_location(  :email => 'test@here.com.au', :phone => '1234 1234', :cell => '2345 2345', :fax => '5678 5678',
+                      :street_1 => 'Test Street 1', :street_2 => 'Test Street 2', :city => 'Test City', :state => 'VIC',
+                      :postal_code => '1234', :country => 'Australia')
+
+== REQUIREMENTS:
+
+activeresource
+
+== INSTALL:
+
+git clone git://github.com/batchblue/batchbook.git
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 BatchBlue Software
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/batchbook.rb'
+
+Hoe.new('batchbook', BatchBook::VERSION) do |p|
+  p.developer('Will Larson', 'technical@batchblue.com')
+  
+  p.extra_deps << ['activeresource', '2.1.0']
+end
+
+# vim: syntax=Ruby

data/lib/batchbook.rb

@@ -0,0 +1,413 @@
+require 'rubygems'
+require 'active_resource'
+
+# Ruby lib for working with the BatchBook's API's XML interface. Set the account
+# name and authentication token, using the BatchBook API Key found in your
+# account settings, and you're ready to roll.
+#
+# http://demo.batchbook.com
+# BatchBook.account = 'demo'
+# BatchBook.token = 'XYZ'
+#
+#
+module BatchBook
+  VERSION = '1.0.4'
+
+  class Error < StandardError; end
+  class << self
+    attr_accessor :host_format, :site_format, :domain_format, :protocol, :path
+    attr_reader :account, :token
+
+    # Sets the account name, and updates all the resources with the new domain.
+    def account=(name)
+      resources.each do |r|
+        r.site = r.site_format % (host_format % [protocol, domain_format % name, path])
+      end
+      @account = name
+    end
+
+    # Sets the BatchBook API Key for all resources.
+    def token=(value)
+      resources.each do |r|
+        r.user = value
+      end
+    end
+    
+    def site=(value)
+      resources.each do |r|
+        r.site = value
+      end
+    end
+
+    def resources
+      @resources ||= []
+    end
+  end
+
+  self.host_format = '%s://%s/%s'
+  self.domain_format = '%s.batchbook.com'
+  self.path = 'service'
+  self.protocol = 'https'
+
+  class Base < ActiveResource::Base
+    @proxy = ''
+    @timeout = 15
+  
+    def self.inherited(base)
+      BatchBook.resources << base
+      class << base
+        attr_accessor :site_format
+      end
+      base.site_format = '%s'
+      super
+    end
+  end
+
+  class Activities < Base
+     
+    def self.recent
+      self.find(:all, :from => :recent)
+    end
+    
+  end
+  
+  class Affiliation < Base    
+    
+  end
+  
+  class Person < Base
+    #http://developer.batchblue.com/people.html
+    def tags
+      Tag.find(:all, :params => {:contact_id => id})
+    end
+
+    def locations
+      self.get('locations')
+    end
+
+    def location label
+      raise Error, "Location label not specified.  Usage:  person.location('label_name')" unless label
+      self.get('locations', :label => label)
+    end
+
+    # Add a Location to a Person
+    # POST https://test.batchbook.com/service/people/#{id}/locations.xml
+    # Field Description
+    # location[label]   Location Name ('work', 'home', etc.) - REQUIRED
+    # location[email]   Email Address
+    # location[website]   Website URL
+    # location[phone]   Phone Number
+    # location[cell]  Cell Phone Number
+    # location[fax]   Fax Number
+    # location[street_1]  Street Address
+    # location[street_2]  Street Address 2
+    # location[city]  City
+    # location[state]   State
+    # location[postal_code]   Postal Code
+    # location[country]   Country
+    def add_location(params = {})
+      params.update(:label => 'home') unless params[:label].present?
+      self.post(:locations, :location => params)
+    end
+
+    def supertags
+      self.get('super_tags')
+    end
+
+    def supertag name
+      raise Error, "SuperTag name not specified.  Usage:  person.supertag('tag_name')" unless name
+      self.get('super_tags', :name => name)
+    end
+
+    #TODO : Fix supertags
+    # Add a SuperTag to a Person
+    #
+    # Add a SuperTag to a Person the same way you add a regular tag to it, via PUT https://test.batchbook.com/service/people/#{id}/add_tag/#{super_tag_name}.xml.
+    # Remove a SuperTag from a Person
+    # DELETE https://test.batchbook.com/service/people/#{id}/super_tags/#{super_tag_name}.xml
+
+    def add_supertag name, params = {}
+      raise Error, "Tag name not specified.  Usage:  person.add_supertag('tag_name')" unless name
+
+      self.put(:add_tag, :tag => name)
+      unless params.empty?
+        self.put("super_tags/#{name.gsub(/ /, '_')}", :super_tag => params)
+      end
+    end
+
+    def add_tag name
+      raise Error, "Tag name not specified.  Usage:  person.add_tag('tag_name')" unless name
+      self.put(:add_tag, :tag => name)
+    end
+
+    def remove_tag name
+      raise Error, "Tag name not specified.  Usage:  person.remove_tag('tag_name')" unless name
+      self.delete(:remove_tag, :tag => name)
+    end
+
+    def comments(scope = :all)
+      Comment.find(scope, :params => {:person_id => self.id})
+    end
+    
+    def comment(id)
+      comments(id)
+    end
+    
+    def affiliations
+      Affiliation.find(:all, :params => {:person_id => self.id})      
+    end
+    
+    def communications
+      Communication.find(:all, :params => {:person_id => self.id})
+    end
+    
+    def todos
+      Todo.find(:all, :params => {:person_id => self.id})
+    end
+  end
+
+  class Company < Base
+    def tags
+      Tag.find(:all, :params => {:contact_id => id})
+    end
+
+    def locations
+      self.get('locations')
+    end
+
+    def location label
+      raise Error, "Location label not specified.  Usage:  person.location('label_name')" unless label
+      self.get('locations', :label => label)
+    end
+
+    def supertags
+      self.get('super_tags')
+    end
+
+    def supertag name
+      raise Error, "SuperTag name not specified.  Usage:  person.supertag('tag_name')" unless name
+      self.get('super_tags', :name => name)
+    end
+
+    def add_tag name
+      raise Error, "Tag name not specified.  Usage:  person.add_tag('tag_name')" unless name
+      self.put(:add_tag, :tag => name)
+    end
+
+    def remove_tag name
+      raise Error, "Tag name not specified.  Usage:  person.remove_tag('tag_name')" unless name
+      self.delete(:remove_tag, :tag => name)
+    end
+    
+    def comments(scope = :all)
+      Comment.find(scope, :params => {:company_id => self.id})
+    end
+    
+    def comment(id)
+      comments(id)
+    end
+    
+    def people
+      Person.find(:all, :params => {:company_id => self.id})
+      # self.get(:people)      
+    end
+    
+    def affiliations
+      Affiliation.find(:all, :params => {:company_id => self.id})      
+    end
+    
+    def communications
+      Communication.find(:all, :params => {:company_id => self.id})
+    end
+    
+    def todos
+      Todo.find(:all, :params => {:company_id => self.id})
+    end
+  end
+
+  class Todo < Base
+    def tags
+      Tag.find(:all, :params => {:todo_id => id})
+    end
+    
+    def add_tag name
+      raise Error, "Tag name not specified.  Usage:  todo.add_tag('tag_name')" unless name
+      self.put(:add_tag, :tag => name)
+    end
+
+    def remove_tag name
+      raise Error, "Tag name not specified.  Usage:  todo.remove_tag('tag_name')" unless name
+      self.delete(:remove_tag, :tag => name)
+    end
+    
+    def comments(scope = :all)
+      Comment.find(scope, :params => {:todo_id => self.id})
+    end
+    
+    def comment(id)
+      comments(id)
+    end
+  end
+  
+  class Deal < Base
+    def tags
+      Tag.find(:all, :params => {:deal_id => id})
+    end
+    
+    def add_tag name
+      raise Error, "Tag name not specified.  Usage:  deal.add_tag('tag_name')" unless name
+      self.put(:add_tag, :tag => name)
+    end
+
+    def remove_tag name
+      raise Error, "Tag name not specified.  Usage:  deal.remove_tag('tag_name')" unless name
+      self.delete(:remove_tag, :tag => name)
+    end
+
+    def comments(scope = :all)
+      Comment.find(scope, :params => {:deal_id => self.id})
+    end
+    
+    def comment(id)
+      comments(id)
+    end
+    
+    def contacts
+      Person.find(:all, :params => {:deal_id => self.id})
+    end
+    
+    def add_related_contact(contact_id)
+      raise Error, "Contact not specified.  Usage: deal.add_contact(50)" unless contact_id
+      self.put(:add_related_contact, :contact_id => contact_id)
+    end
+    
+    def remove_related_contact(contact_id)
+      raise Error, "Contact not specified.  Usage: deal.add_contact(50)" unless contact_id
+      self.delete(:remove_related_contact, :contact_id => contact_id)
+    end
+  end
+
+  class Communication < Base
+    def tags
+      Tag.find(:all, :params => {:communication_id => id})
+    end
+    
+    def add_tag name
+      raise Error, "Tag name not specified.  Usage:  communication.add_tag('tag_name')" unless name
+      self.put(:add_tag, :tag => name)
+    end
+
+    def remove_tag name
+      raise Error, "Tag name not specified.  Usage:  communication.remove_tag('tag_name')" unless name
+      self.delete(:remove_tag, :tag => name)
+    end
+    
+    def comments(scope = :all)
+      Comment.find(scope, :params => {:communication_id => self.id})
+    end
+    
+    def comment(id)
+      comments(id)
+    end
+  end
+
+  class Comment < Base
+
+    def communication
+      Communication.find(self.prefix_options[:communication_id])
+    end
+
+    def communication=(communication)
+      self.prefix_options[:communication_id] = communication.id
+    end
+    
+    def company
+      Company.find(self.prefix_options[:company_id])
+    end
+    
+    def company=(company)
+      self.prefix_options[:company_id] = company.id
+    end
+    
+    def deal
+      Deal.find(self.prefix_options[:deal_id])
+    end
+    
+    def deal=(deal)
+      self.prefix_options[:deal_id] = deal.id
+    end
+        
+    def list
+      List.find(self.prefix_options[:list_id])
+    end
+
+    def list=(list)
+      self.prefix_options[:list_id] = list.id
+    end
+    
+    def person
+      Person.find(self.prefix_options[:person_id])
+    end
+
+    def person=(person)
+      self.prefix_options[:person_id] = person.id
+    end
+
+    def todo
+      Todo.find(self.prefix_options[:todo_id])
+    end
+
+    def todo=(todo)
+      self.prefix_options[:todo_id] = todo.id
+    end
+    
+  end
+
+  class List < Base
+    def comments(scope = :all)
+      Comment.find(scope, :params => {:list_id => self.id})
+    end
+    
+    def comment(id)
+      comments(id)
+    end
+  end
+
+  class Tag < Base
+  end
+
+  class Location < Base
+  end
+
+  class SuperTag < Base
+  end
+  
+  class Record < Base
+  end
+
+end
+
+__END__
+
+require 'batchbook'
+BatchBook.account = 'devo'
+BatchBook.token = 'xyZ'
+
+search_by_name = BatchBook::Person.find(:all, :params => {:name => 'will'} )
+search_by_email = BatchBook::Person.find(:all, :params => {:email => will@batchblue.com})
+
+person = BatchBook::Person.find 1937
+person.last_name = 'new last name'
+person.save
+
+new_person = BatchBook::Person.new :first_name => 'will', :last_name => 'larson', :title => 'dev'
+new_person.save
+new_person_comment = BatchBook.Comment.new :comment => 'Best comment ever'
+new_person_comment.person = new_person
+new_person_comment.save
+assert new_person.comments.include? new_person_comment
+
+
+
+
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: batchbook
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 3
+  version: 1.0.3
+platform: ruby
+authors: 
+- Will Larson
+- Eric Krause
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-14 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id001
+description: Wrapper for BatchBook XML API
+email: 
+- technical@batchblue.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/batchbook.rb
+has_rdoc: true
+homepage: http://github.com/batchblue/batchbook
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Wrapper for BatchBook XML API
+test_files: []
+

metadata.gz.sig

@@ -0,0 +1,2 @@
+)�bnL0}�쌅=�k�|��^~7�z�tm��Th �x#"��!׸'4>�(@���q�qe#��`�������h
Z��5��S2���U��q�>��"+�a9��<��+9�#U˻Fx�,VY��p#`��������̿�C
+pBk�ɛ�&6۟��
�DЙӀv�SFG�_�=]����*H���IrhkB����kt�޴H����B�b���6���?�	��]��$�G�ͦpO:'̨��$	t�խ�