pipejump 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,25 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+spec/connection.yml
+coverage
+coverage.data
+test*.rb

data/Gemfile

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby
+source "http://rubygems.org"
+
+gem 'rspec', '1.3.0'
+gem 'rake'
+gem 'jeweler'
+gem 'rcov'

data/Gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    gemcutter (0.5.0)
+      json_pure
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    rake (0.8.7)
+    rcov (0.9.8)
+    rspec (1.3.0)
+    rubyforge (2.0.3)
+      json_pure (>= 1.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rake
+  rcov
+  rspec (= 1.3.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Marcin Bunsch
+
+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/README.rdoc

@@ -0,0 +1,120 @@
+*pipejump* gem is a Ruby-based client for the API of the Pipejump sales app.
+
+== Requirements
+
+There are no dependencies required to use this code.
+
+== Installation
+
+The gem available via Rubygems. To install it, use the following command:
+
+
+     sudo gem install pipejump
+
+
+To get the latest version, clone the gem from github and run rake install:
+
+
+     git clone http://github.com/pipejump/pipejump
+     cd pipejump
+     rake install
+
+
+== Usage
+
+Before using this gem you must require it by calling:
+
+ 
+     require 'pipejump'
+
+
+=== Session
+
+To use the client, you must first authenticate the client with the API by initializing an instance of the Pipejump::Session class. You will later use this instance for communication with the API.
+
+
+     @session = Pipejump::Session.new(:email => 'you@email.com', :password => 'your_password')
+
+
+If the credentials are incorrect, this will raise a Pipejump::AuthenticationFailed error.
+
+If authentication succeeds, this will return a new Pipejump::Session instance which you can use to communicate with the API.
+
+As of version 0.1.1 you can use the token which is fetched when authenticating using the email and password. So once you get the token, you can use it for future initialization of the Session and not send the username and password, which is a more secure.
+
+  @session = Pipejump::Session.new(:token => 'your_token')
+
+Also, as of version 0.1.1 connection is performed over SSL.
+
+For more information on the Session, consult the wiki page at http://github.com/pipejump/pipejump/wiki/Session
+
+To access any resources, you need a valid Session instance, referred to as @session in the following examples.
+
+=== Account
+
+You can access your account by calling 
+
+
+     @session.account
+
+
+For more information, consult the wiki page at http://github.com/pipejump/pipejump/wiki/Account
+
+=== Deals
+
+You can access your deals by calling 
+
+
+     @session.deals
+
+
+With Deals you get access to Notes, Reminders and Deal Contacts.
+
+For more information, consult the wiki page at http://github.com/pipejump/pipejump/wiki/Deals
+
+=== Clients
+
+You can access your clients by calling 
+
+
+     @session.clients
+
+
+For more information, consult the wiki page at http://github.com/pipejump/pipejump/wiki/Clients
+
+=== Contacts
+
+You can access your contacts by calling 
+
+
+     @session.contacts
+
+
+For more information, consult the wiki page at http://github.com/pipejump/pipejump/wiki/Contacts
+
+=== Sources
+
+You can access your sources by calling 
+
+
+     @session.sources
+
+
+For more information, consult the wiki page at http://github.com/pipejump/pipejump/wiki/Sources
+
+== Contribution
+
+You're more than welcome to fork and improve this gem. Usual rules:
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+  bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request.
+
+== Copyright
+
+Copyright (c) 2010 Pipejump. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require "rubygems"
+require "bundler/setup"
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "pipejump"
+    gem.summary = %Q{Pipejump API Ruby client}
+    gem.description = %Q{Pipejump API Ruby client}
+    gem.email = "marcin@pipejump.com"
+    gem.homepage = "http://github.com/pipejump/pipejump"
+    gem.authors = ["Marcin Bunsch"]
+    gem.add_development_dependency "bundler", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+
+begin
+  require 'rcov/rcovtask'
+  
+  desc "Run rcov for rspec"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_files = FileList['spec/pipejump/**/*_spec.rb']
+    t.spec_opts = %w{--color}
+    t.rcov = true
+    t.rcov_opts = %w{--html --exclude osx\/objc,gems\/,spec\/}
+    t.rcov_opts << %[-o "coverage"]
+  end
+
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/pipejump/*_spec.rb', 'spec/pipejump/**/*_spec.rb']
+  t.spec_opts = %w{--color}
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pipejump-client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/pipejump/base/collection.rb

@@ -0,0 +1,117 @@
+module Pipejump
+  
+  # Represents a collection Resources available in the Pipejump API
+  # 
+  # ==== Available Collections:
+  # * Clients
+  #     @session.clients
+  # * Contacts
+  #     @session.contacts
+  # * Sources
+  #     @session.sources
+  # * Notes in a Deal
+  #     @deal.notes
+  # * Reminders in a Deal
+  #     @deal.reminders
+  # * Contacts in a Deal
+  #     @deal.contacts
+  #   *Please* *note*: This Collection has the following methods disabled: find, create
+  #
+  # ==== Additional methods:
+  # Additionally, each collection allows shorthand calls to the Array returned via all for the following methods:
+  # * first
+  # * last
+  # * each
+  # * size
+  # * collect
+  # * reject
+  # ===== Example:
+  #   @session.sources.size
+  #   @session.sources.each { |source| }
+  class Collection
+    
+    class << self
+      # Disable methods specified as arguments
+      def disable(*methods) #:nodoc:
+        methods.each do |method|
+          class_eval <<-STR
+            def #{method}; raise NotImplemented; end
+          STR
+        end
+      end
+    end
+
+    # Create a new Collection of Resource objects
+    # ==== Arguments
+    # * _session_ - Session object
+    # * _resource_ - class of the Resource for this collection
+    # * _owner_ - a Resource object which owns the collection, applies scope to calls
+    # ==== Usage
+    # Normally you do not call the constructor directly, instead you go via the Session or Deal instance, like this:
+    #   @session.clients
+    # or
+    #   @deal.notes
+    # 
+    def initialize(session, resource, owner = nil)
+      @session = session
+      @resource = resource
+      @owner = owner
+      @prefix = owner ? owner.element_path : ''
+    end
+    
+    # Returns a path to the collection of Resource objects
+    def collection_path
+      @prefix + '/' + @resource.collection_path.to_s 
+    end
+
+    # Returns a path to a single Resource
+    def element_path(id)
+      @prefix + '/' + @resource.collection_path.to_s + '/' + id.to_s 
+    end
+    
+    # Returns a single Resource object, based on its _id_
+    # ==== Arguments
+    # * _id_ - id of Resource 
+    def find(id)
+      code, data = @session.get(element_path(id) + '.json')
+      if code == 200
+        key = @resource.name.to_s.split('::').last.downcase
+        @resource.new(data[key].merge(:session =>@session))
+      elsif code == 404
+        raise ResourceNotFound
+      end
+    end
+    
+    # Returns an Array of Resource objects
+    def all
+      code, data = @session.get(collection_path + '.json')
+      data.collect { |data|
+        key = @resource.name.to_s.split('::').last.downcase
+        @resource.new(data[key].merge(:session => @session, :prefix => @prefix))
+      }
+    end
+    
+    # Creates and returns a Resource object
+    # ==== Arguments
+    # * _attrs_ - a Hash of attributes passed to the constructor of the Resource
+    def create(attrs)
+      resource = @resource.new(attrs.merge(:session => @session, :prefix => @prefix))
+      resource.save
+      resource
+    end
+    
+    def inspect
+      all.inspect
+    end
+    
+    ['first', 'last', 'each', 'size', 'collect', 'reject'].each do |method|
+      class_eval <<-STR
+        def #{method}(*args, &block)
+          all.#{method}(*args, &block)
+        end
+      STR
+    end
+        
+  end
+  
+end

data/lib/pipejump/base/connection.rb

@@ -0,0 +1,54 @@
+require 'uri'
+module Pipejump
+  
+  class Connection #:nodoc:
+    
+    attr_accessor :session, :endpoint
+
+    def initialize(session, endpoint = nil)
+      @session = session
+      @endpoint = endpoint || 'https://api.pipejump.com'
+    end
+       
+    def site
+      parser = URI.const_defined?(:Parser) ? URI::Parser.new : URI
+      parser.parse(self.endpoint)
+    end
+    
+    def post(path, data)
+      http.post(path, data, headers)
+    end
+
+    def put(path, data)
+      http.put(path, data, headers)
+    end
+
+    def get(path)
+      http.get(path, headers)
+    end
+
+    def delete(path)
+      http.delete(path, headers)
+    end
+    
+    def headers
+      { 'X-Pipejump-Auth' => session.token.to_s }
+    end
+    
+    def http
+      instance ||= Net::HTTP.new(site.host, site.port)
+      if @endpoint.match(/^https:/)
+        instance.use_ssl = true
+        instance.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      instance
+    end
+    
+    def inspect
+      "#<#{self.class} endpoint: \"#{endpoint}\">"
+    end
+    
+    
+  end
+
+end

data/lib/pipejump/base/errors.rb

@@ -0,0 +1,11 @@
+module Pipejump  
+  # Error raised when authentication fails
+  class AuthenticationFailed < Exception; end
+  
+  # Error raised when a resource is not found via find
+  class ResourceNotFound < Exception; end
+  # Error raised when a method is called but is not available for that object
+  #
+  # Example: Pipejump::Collection of Contact objects within a Deal has the following methods disabled: find, create
+  class NotImplemented < Exception; end
+end

data/lib/pipejump/base/resource.rb

@@ -0,0 +1,182 @@
+module Pipejump
+  #
+  # Represents a Resource available in the Pipejump API
+  # 
+  # The following Resources are available:
+  # * Account via @session.account
+  # * Client via @session.clients
+  # * Contact via @session.contacts
+  # * Deal via @session.deals
+  # * Note via @deal.notes
+  # * Reminder via @deal.reminders
+  # * Source via @deal.sources
+  # 
+  # === Retrieving Resources
+  # For information on retrieving resources, please consult the Collection class
+  #
+  # === Creating a Resource 
+  # To create a resource, call the create method on the appropriate collection.
+  # 
+  # For example, to create a client, you would do the following:
+  #   @client = @session.clients.create(:name => 'Google')
+  # This will return an instance of Pipejump::Client 
+  # 
+  # You can access the attributes of the instance via the attributes method:
+  #   @client.attributes # => { 'id' => 1, 'name' => 'Google' }
+  # 
+  # Pipejump::Resource also provides shortcut accessors for these attributes, similarly to ActiveRecord:
+  #   @client.name = 'Yahoo'
+  #   @client.name # => 'Yahoo'
+  # 
+  # If the create fails, errors are available via the errors method
+  #   @client = @session.clients.create(:name => '')
+  #   @client.errors # => {"client"=>[{"error"=>{"code"=>"E0001", "field"=>"name", "description"=>"Please enter a client name"}}]}
+  # 
+  # For more information on errors, please consult the Pipejump API documentation
+  #
+  # === Updating a Resource
+  # To update a resource, change the desired attributes and call the save method
+  #   @client.name = 'Yahoo'
+  #   @client.save
+  # 
+  # The save method returns the instance on successful save.
+  #
+  # If the update fails, save returns false and errors are available via the errors method
+  #   @client.name = ''
+  #   @client.save # => false
+  #   @client.errors # => {"client"=>[{"error"=>{"code"=>"E0001", "field"=>"name", "description"=>"Please enter a client name"}}]}
+  # 
+  # For more information on errors, please consult the Pipejump API documentation
+  # 
+  # === Removing a resource
+  # To remove a resource, call the destroy method on the Pipejump::Resource instance
+  #   @client.destroy # => true
+  #
+  class Resource
+       
+    class << self
+      # Returns the pluralized name of the resource used for the collection
+      def collection_path(path = nil)
+        @collection_path = path if path
+        @collection_path || "#{self.to_s.split('::').last.downcase}s"
+      end
+      
+      # Naive implementation of belongs_to association
+      def belongs_to(klass) #:nodoc:
+        class_eval <<-STR
+          def #{klass}
+            if @attributes['#{klass}'].is_a?(Hash)
+              Pipejump::#{klass.to_s.capitalize}.new(@attributes['#{klass}'].merge(:session => @session))
+            elsif @attributes['#{klass}_id']
+              @session.#{klass}s.find(@attributes['#{klass}_id'])
+            end
+          end
+        STR
+      end
+      
+      # Naive implementation of has_many association
+      attr_accessor :has_many_blocks #:nodoc:
+      def has_many(collection, &block) #:nodoc:
+        (self.has_many_blocks ||= {})[collection] = block
+        class_eval <<-STR
+          def #{collection}
+            collection = Collection.new(@session, #{collection.to_s[0..-2].capitalize}, self)
+            if self.class.has_many_blocks[:#{collection}]
+              (class << collection; self; end).class_eval(&self.class.has_many_blocks[:#{collection}])
+            end
+            collection
+          end
+        STR
+        
+      end
+      
+    end
+    
+    attr_accessor :attributes
+    # Constructor for the Resource
+    def initialize(attrs)
+      @session = attrs.delete(:session)
+      @prefix = attrs.delete(:prefix) || ''
+      @attributes = {}
+      load(attrs)
+    end
+    
+    def id
+      @attributes['id']
+    end
+    
+    def load(attrs = {}) #:nodoc:
+      attrs.each_pair do |key, value|
+        @attributes[key.to_s] = value
+      end      
+    end
+    
+    def method_missing(meth, *args) #:nodoc:
+      if meth.to_s[-1].chr == '=' and @attributes[meth.to_s[0..-2]]
+        @attributes[meth.to_s[0..-2]] = args.first
+      elsif @attributes.has_key?(meth.to_s)
+        @attributes[meth.to_s]
+      else
+        super(meth, args)
+      end
+    end
+    
+    def klassname #:nodoc:
+      self.class.to_s.split('::').last.downcase
+    end
+    
+    def to_query
+      @attributes.collect { |pair| pair[0] = "#{klassname}[#{pair[0]}]"; pair.join('=') }.join('&')
+    end
+    
+    def save
+      before_save if respond_to?(:before_save)
+      @errors = {}
+      code, data = id ? update : create # @session.post('/' + self.class.collection_path.to_s + '.json', to_query)
+      if data['errors']
+        @errors = data['errors']
+        false
+      else
+        load(data[klassname])
+        true
+      end
+    end
+    
+    def inspect
+      "#<#{self.class} #{@attributes.collect { |pair| pair[1] = "\"#{pair[1]}\""; pair.join(': ') }.join(', ')}>"
+    end
+    
+    def element_path
+      @prefix + '/' + self.class.collection_path.to_s + '/' + id.to_s
+    end
+    
+    def collection_path
+      @prefix + '/' + self.class.collection_path.to_s 
+    end
+    
+    def create #:nodoc:
+      @session.post(collection_path + '.json', to_query)      
+    end
+
+    def update #:nodoc:
+      @session.put(element_path + '.json', to_query)      
+    end
+    
+    # Destroys the Resource
+    def destroy
+      code, data = @session.delete(element_path + '.json')
+      code.to_i == 200
+    end
+    
+    # Returns a Hash of errors
+    def errors
+      @errors ||= {}
+    end
+    
+    def created?
+      !!id
+    end
+    
+  end
+  
+end