pipeline_deals 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,11 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem 'activeresource', '4.0.0.beta1'
+
+group :test do
+  gem 'rspec'
+  gem 'pry'
+  gem 'vcr'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      builder (~> 3.1.0)
+    activeresource (4.0.0.beta1)
+      activemodel (>= 4.0.0.beta1)
+      activesupport (>= 4.0.0.beta1)
+      rails-observers (~> 0.1.1)
+    activesupport (4.0.0.beta1)
+      i18n (~> 0.6.2)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.33)
+    addressable (2.3.4)
+    atomic (1.1.8)
+    builder (3.1.4)
+    coderay (1.0.8)
+    crack (0.3.2)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    i18n (0.6.4)
+    json (1.7.7)
+    method_source (0.8.1)
+    minitest (4.3.3)
+    multi_json (1.7.2)
+    pry (0.9.12)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails-observers (0.1.1)
+      railties (~> 4.0.0.beta)
+    railties (4.0.0.beta1)
+      actionpack (= 4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.17.0, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12.1)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    slop (3.4.3)
+    thor (0.17.0)
+    thread_safe (0.1.0)
+      atomic
+    tzinfo (0.3.35)
+    vcr (2.3.0)
+    webmock (1.11.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activeresource (= 4.0.0.beta1)
+  pry
+  rspec
+  vcr
+  webmock

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Grant Ammons
+
+MIT License
+
+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.md

@@ -0,0 +1,54 @@
+# PipelineDeals API gem
+
+The PipelineDeals API gem is a nice ruby wrapper around the PipelineDeals API.  It will allow you full CRUD access to all of the core PipelieDeals components in a very easy-to-use library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pipeline_deals'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pipeline_deals
+
+## Usage
+
+First and foremost, register your api key:
+
+```ruby
+PipelineDeals.api_key = 'abcd1234'
+```
+
+
+### Getting a single deal, person, or company:
+
+```ruby
+deal = Deal.find(1234)      # find the deal
+deal.name = 'blah2'         # change an attribute
+deal.save                   # re-save the deal to the site
+deal.people                 # associations are respected
+deal.people.first.id
+deal.person_ids           
+```
+
+### Fetching collections of deals, people, or companies
+
+```ruby
+deals = Deal.find(:all)
+deals = Deal.find(:all, params: {per_page: 5, page: 2})
+deals = Deal.find(:all, params: {conditions: {deal_name: 'blah'}})
+deals = Deal.where(conditions: {deal_name: 'blah'})
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/a_spike.rb

@@ -0,0 +1,72 @@
+require 'rubygems'
+require 'active_resource'
+require 'pry'
+
+class PldCollection < ActiveResource::Collection
+  attr_accessor :pagination
+  def initialize(parsed = {})
+    @pagination = parsed['pagination']
+    @elements = parsed['entries']
+  end
+end
+
+class PldResource < ActiveResource::Base
+  self.site = "http://localhost:3000/api/v3"
+  self.collection_parser = PldCollection
+
+  def self.find(*arguments)
+    scope = arguments.slice!(0)
+    options = arguments.slice!(0) || {}
+
+    if options[:params]
+      options[:params].merge!({api_key: 'n8PJJWRsx0MxgOEwGk7'})
+    else
+      options.merge!({params: {api_key: 'n8PJJWRsx0MxgOEwGk7'}})
+    end
+
+    super(scope, options)
+  end
+
+  def save
+    prefix_options[:api_key] = 'n8PJJWRsx0MxgOEwGk7'
+    self.include_root_in_json = true
+    super
+  end
+end
+
+class Person < PldResource
+end
+
+class Deal < PldResource
+  has_many :people
+end
+
+#################################o
+# Finding a single and putting
+#################################o
+
+# deal = Deal.find(1)
+# $stdout << "found, deal = #{deal.inspect}\n"
+# deal.name = 'blah2'
+# $stdout << "About to save name:\n"
+# deal.people
+# deal.person_ids
+# deal.custom_fields.custom_label_29 = 345
+#deal.save
+
+#################################o
+# fetching collections
+#################################o
+
+# deals = Deal.find(:all)
+# deals = Deal.find(:all, params: {per_page: 5, page: 2})
+# deals = Deal.find(:all, params: {conditions: {deal_name: 'blah'}})
+# deals = Deal.where(conditions: {deal_name: 'blah'})
+
+
+#################################o
+# creating
+#################################o
+
+deal = Deal.new(name: 'yeah2')
+20.times {deal.save }

data/lib/collection.rb

@@ -0,0 +1,9 @@
+module PipelineDeals
+  class Collection < ActiveResource::Collection
+    attr_accessor :pagination
+    def initialize(parsed = {})
+      @pagination = parsed['pagination']
+      @elements = parsed['entries']
+    end
+  end
+end

data/lib/pipeline_deals.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'active_resource'
+require_relative 'collection'
+require_relative 'resource'
+require_relative 'resources/definitions.rb'
+require_relative 'version'
+
+Dir[File.dirname(__FILE__) + '/resources/*.rb'].each {|file| require file }
+
+module PipelineDeals
+  def self.api_key
+    @api_key
+  end
+
+  def self.api_key=(key)
+    @api_key = key
+  end
+end

data/lib/resource.rb

@@ -0,0 +1,25 @@
+module PipelineDeals
+  class Resource < ActiveResource::Base
+    self.site = "https://api.pipelinedeals.com/api/v3"
+    self.collection_parser = PipelineDeals::Collection
+
+    def self.find(*arguments)
+      scope = arguments.slice!(0)
+      options = arguments.slice!(0) || {}
+
+      if options[:params]
+        options[:params].merge!({api_key: PipelineDeals.api_key})
+      else
+        options.merge!({params: {api_key: PipelineDeals.api_key}})
+      end
+
+      super(scope, options)
+    end
+
+    def save
+      prefix_options[:api_key] = PipelineDeals.api_key
+      self.include_root_in_json = true
+      super
+    end
+  end
+end

data/lib/resources/company.rb

@@ -0,0 +1,7 @@
+module PipelineDeals
+  class Person < PipelineDeals::Resource
+    has_many :deals, :class_name => PipelineDeals::Deal
+    has_many :people, :class_name => PipelineDeals::Company
+  end
+end
+

data/lib/resources/deal.rb

@@ -0,0 +1,56 @@
+module PipelineDeals
+  class Deal < PipelineDeals::Resource
+    has_many :people, :class_name => PipelineDeals::Person
+    has_one :primary_contact, :class_name => PipelineDeals::Person
+    has_one :company, :class_name => PipelineDeals::Company
+    belongs_to :user, :class_name => PipelineDeals::User
+
+  # {"summary"=>nil,
+  #  "primary_contact_id"=>24,
+  #  "expected_close_date"=>nil,
+  #  "deal_stage_id"=>nil,   "name"=>"blah2",
+  #  "primary_contact"=>
+  #   #<PipelineDeals::Deal::PrimaryContact:0x007f92c396b100
+  #    @attributes={"id"=>24, "last_name"=>"buttface", "first_name"=>"Jo"},
+  #    @persisted=true,
+  #    @prefix_options={}>,
+  #  "user_id"=>1,
+  #  "company_id"=>nil,
+  #  "source_id"=>nil,
+  #  "is_example"=>nil,
+  #  "created_at"=>"2013/04/16 10:09:41 -0400",
+  #  "company"=>nil,
+  #  "person_ids"=>[24, 25],
+  #  "collaborators"=>[],
+  #  "people"=>
+  #   [#<PipelineDeals::Person:0x007f92c3969a30
+  #     @attributes={"id"=>24, "last_name"=>"buttface", "first_name"=>"Jo"},
+  #     @persisted=true,
+  #     @prefix_options={}>,     #<PipelineDeals::Person:0x007f92c39684a0
+  #     @attributes={"id"=>25, "last_name"=>"O'Kon", "first_name"=>"Sherman"},      @persisted=true,      @prefix_options={}>],
+  #  "status"=>2,
+  #  "custom_fields"=>
+  #   #<PipelineDeals::Deal::CustomFields:0x007f92c396d928
+  #    @attributes=
+  #     {"custom_label_29"=>54321,
+  #      "custom_label_27"=>nil,
+  #      "custom_label_26"=>nil,
+  #      "custom_label_25"=>nil},
+  #    @persisted=true,
+  #    @prefix_options={}>,
+  #  "probability"=>99,
+  #  "is_archived"=>false,
+  #  "closed_time"=>nil,
+  #  "deal_stage"=>nil,
+  #  "id"=>1,
+  #  "user"=>
+  #   #<PipelineDeals::Deal::User:0x007f92c3976f00
+  #    @attributes={"id"=>1, "last_name"=>"hoboson", "first_name"=>"hobo"},
+  #    @persisted=true,
+  #    @prefix_options={}>,
+  #  "value_in_cents"=>5588600,
+  #  "import_id"=>nil,
+  #  "updated_at"=>"2013/04/19 18:18:36 -0400",
+  #  "expected_close_date_event_id"=>nil},
+  end
+end

data/lib/resources/definitions.rb

@@ -0,0 +1,10 @@
+module PipelineDeals
+  class Deal < PipelineDeals::Resource; end
+  class Person < PipelineDeals::Resource; end
+  class Company < PipelineDeals::Resource; end
+  class Activity < PipelineDeals::Resource; end
+  class CalendarTask < PipelineDeals::Resource; end
+  class CalendarEvent < PipelineDeals::Resource; end
+  class Document < PipelineDeals::Resource; end
+  class User < PipelineDeals::Resource; end
+end

data/lib/resources/person.rb

@@ -0,0 +1,6 @@
+module PipelineDeals
+  class Person < PipelineDeals::Resource
+    has_many :deals, :class_name => PipelineDeals::Deal
+    has_one :company, :class_name => PipelineDeals::Company
+  end
+end

data/lib/resources/user.rb

@@ -0,0 +1,5 @@
+module PipelineDeals
+  class User < PipelineDeals::Resource
+  end
+end
+

data/lib/version.rb

@@ -0,0 +1,3 @@
+module PipelineDeals
+  VERSION = "0.0.1"
+end

data/pipeline_deals.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require './lib/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "pipeline_deals"
+  gem.version       = PipelineDeals::VERSION
+  gem.authors       = ["Grant Ammons"]
+  gem.email         = ["gammons@gmail.com"]
+  gem.description   = %q{The pipeline_deals gem is a nice ruby wrapper around the PipelineDeals API.}
+  gem.summary   = %q{The pipeline_deals gem is a nice ruby wrapper around the PipelineDeals API.}
+  gem.homepage      = "https://github.com/PipelineDeals/pipelinedeals_api"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency('activeresource', '4.0.0.beta1')
+end