hubspot 0.0.2 → 1.0.0

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2012 Reinier de Lange
-
-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

@@ -1,158 +0,0 @@
-= Hubspot
-
-This gem is a Rails Engine for communicating with several Hubspot API's. Furthermore, it provides some helpers
-to easily integrate Hubspot in your website. This gem only uses standard ActiveResource and Net/HTTP and has been
-tested with unit tests and VCR for replaying HTTP requests.
-
-== Requirements
-
-Rails 3
-
-== Installation
-
-Add hubspot to your Gemfile:
-
-  gem 'hubspot'
-
-== Configuration
-
-This gem is a Rails Engine. The gem can be configured by changing the default engine configuration. The following settings
-can be added to your application.rb or an initializer:
-
-* *Hubspot.config.hubspot_site*         = 'demo.app11.hubspot.com'
-  
-  The domain of your Hubspot site, which is used in the javascript tracker code
-
-* *Hubspot.config.hubspot_access_token* = 'demooooo-oooo-oooo-oooo-oooooooooooo'
-  
-  The access token for authenticating to several Hubspot services
-
-* *Hubspot.config.hubspot_key*          = 'demo'
-  
-  Your API key
-
-* *Hubspot.config.hubspot_portal_id*    = '62515'
-  
-  Your Portal ID
-
-* *Hubspot.config.debug_http_output*    = false
-  
-  Enables/disables logging of HTTP requests and response. False disables debugging, setting it to STDOUT enables logging to   STDOUT. Of course you can specify any IO object you want.
-
-== Usage
-
-Currently, the gem supports the following Hubspot API's:
-
-=== Leads
-
-See: http://developers.hubspot.com/docs/endpoints#leads-api
-
-==== Finds
-
-  Hubspot::Lead.find :all, :params => { :search => 'test' }
-  Hubspot::Lead.find <GUID>  
-
-==== Updates
-
-  lead.firstName = 'Reinier'; lead.save!
-  lead.update_attributes(:firstName => 'Reinier')
-
-=== Blogs (including posts and comments)
-
-See: http://developers.hubspot.com/docs/endpoints#blog-api
-
-==== Finds
-  
-  Hubspot::Blog.find :all, :params => { :max => 10 }
-  Hubspot::Blog.find <GUID>  
-    
-==== Comments
-  
-  Hubspot::Blog.find('guid').comments  
-  
-==== Posts
-  
-  Hubspot::Blog.find('guid').posts
-  
-===== Post comments
-    
-  Hubspot::Blogs::Post.find("6ca6fdc5-a81f-44db-a63b-f56ab2636c69", :params => { :blog_guid => "0d61e4ca-e395-4c1c-8766-afaa48bf68db" }).comments
-
-=== Keywords
-
-See: http://developers.hubspot.com/docs/endpoints#keywords-api
-
-==== Finds
-
-  Hubspot::Keyword.find(:all, :params => { :max => 5 })
-  Hubspot::Keyword.find('guid')
-  
-==== Creates
-
-  Hubspot::Keyword.create!({ :keyword => { :keyword => 'key' }})      
-  Hubspot::Keyword.create({ :keyword => { :keyword => 'key' }})  
-  
-=== Events
-
-See: http://developers.hubspot.com/docs/endpoints#events-api
-
-==== Finds
-
-  Hubspot::Event.find(:all, :params => { :max => 5 })
-  
-==== Creates
-
-  Hubspot::Event.create!(:eventType => 'new event', :description => 'test')
-  Hubspot::Event.create(:eventType => 'new event', :description => 'test')  
-  
-=== Performable events
-
-See: http://performabledoc.hubspot.com/display/DOC/HTTP+API
-
-==== Records
-
-  event = Hubspot::Performable::Event.new('event-12345', Date.civil(2012), nil, 'http://example.com')
-  event.custom_parameters = { :email => 'test@example.com' }  
-  event.record!
-
-Please take a look at the unit tests for examples!
-
-== Action controller extensions
-
-For now, there is only a convenience method for getting the current user token:
-
-  hubspot_user_token # Retrieves the user token from the Hubspot 'hubspotutk' cookie (if any)
-
-== HubspotHelper
-
-The HubspotHelper can be used to insert the Hubspot javascript tracker code to your website. First include the helper:
-
-  class ApplicationController < ActionController::Base
-    helper HubspotHelper
-  end
-  
-Then, you can add the javascript tracker code easily by calling the helper:
-
-  <body>
-    ...
-    <%= hubspot_javascript_tracker %>
-  </body>
-  
-== Acknowledgements
-
-* Thanks go to Josh Lane from which I took some of the code of his Hubspot API implementation (https://github.com/lanej/hubspot-api)
-  
-== Note on Patches/Pull Requests
- 
-* 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. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2012 Reinier de Lange. See LICENSE for details.  
-  

data/Rakefile

@@ -1,38 +0,0 @@
-#!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Hubspot'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
-Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task :default => :test

data/app/helpers/hubspot_helper.rb

@@ -1,17 +0,0 @@
-module HubspotHelper
-  
-  # Should be included at the bottom of any HTML page (before </body>) you want to track
-  def hubspot_javascript_tracker
-    raw <<-EOS
-      <!-- Start of HubSpot Logging Code -->
-      <script type="text/javascript" language="javascript">
-      var hs_portalid=#{Hubspot.config.hubspot_portal_id}; 
-      var hs_salog_version = "2.00";
-      var hs_ppa = "#{Hubspot.config.hubspot_site}";
-      document.write(unescape("%3Cscript src='" + document.location.protocol + "//" + hs_ppa + "/salog.js.aspx' type='text/javascript'%3E%3C/script%3E"));
-      </script>
-      <!-- End of HubSpot Logging Code -->    
-    EOS
-  end
-  
-end

data/app/models/hubspot/base.rb

@@ -1,40 +0,0 @@
-require "active_resource"
-
-# Hubspot::Base initializes ActiveResource to use JSON and to use our own Connection class that adds authentication
-# information to each request. Moreover, as Hubspot's API paths are very inconsistent, it provides the most common
-# paths to object collections and members. This can be overridden if necessary
-module Hubspot
-
-  class Base < ActiveResource::Base
-    self.format = ActiveResource::Formats::JsonFormat
-
-    # Only serialize the attributes listed in the schema. Leads can contain much more information than can be passed
-    # back to Hubspot, therefore we need to ensure they are not serialized on save.
-    def to_json(options={})
-      super(options.reverse_merge(:root => nil, :only => schema.keys))
-    end     
-    
-    class << self
-      
-      # Use our own connection class
-      def connection(refresh = false)
-        @connection = Hubspot::Connection.new(site, format) if @connection.nil? || refresh
-        return @connection
-      end
-      
-      # ==== Set paths ====
-      
-      def element_path(id, prefix_options = {}, query_options = nil)
-        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
-        "#{prefix(prefix_options)}#{collection_name.singularize}/#{URI.escape id.to_s}.#{format.extension}#{query_string(query_options)}"
-      end      
-      
-      def collection_path(prefix_options = {}, query_options = nil)
-        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
-        "#{prefix(prefix_options)}list.#{format.extension}#{query_string(query_options)}"
-      end      
-      
-    end
-  end
-
-end

data/app/models/hubspot/blog.rb

@@ -1,35 +0,0 @@
-module Hubspot
-  
-  # Finds blogs
-  #
-  # Finds:
-  # Hubspot::Blog.find :all, :params => { :max => 10 }
-  # Hubspot::Blog.find <GUID>  
-  class Blog < Hubspot::Base
-    self.site = 'https://api.hubapi.com/blog/v1'
-    
-    schema do
-      string 'guid', 'blogTitle', 'feedUrl', 'jsonUrl', 'webUrl'
-    end
-    
-    alias_attribute :id, :guid
-    
-    # Convenience methods for retrieving a blog's posts and comments
-    
-    def comments(params = {})
-      Hubspot::Blogs::Comment.find :all, :params => params.merge(:blog_guid => guid)
-    end
-    
-    def posts(params = {})
-      Hubspot::Blogs::Post.find :all, :params => params.merge(:blog_guid => guid)
-    end
-
-    # Explicitly set element path 
-    def self.element_path(id, prefix_options = {}, query_options = nil)
-      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
-      "#{prefix(prefix_options)}#{URI.escape id.to_s}.#{format.extension}#{query_string(query_options)}"
-    end   
-  
-  end
-  
-end

data/app/models/hubspot/blogs/blog_association.rb

@@ -1,35 +0,0 @@
-module Hubspot
-  module Blogs
-    
-    # Define an assocation base class from which blog child associations should inherit    
-    class BlogAssociation < Hubspot::Base
-      self.site = Hubspot::Blog.site
-      
-      alias_attribute :id, :guid   
-      
-      class << self
-        def element_path(id, prefix_options = {}, query_options = nil)
-          prefix_options, query_options = split_options(prefix_options) if query_options.nil?
-          "#{prefix(prefix_options)}#{collection_name}/#{URI.escape id.to_s}.#{format.extension}#{query_string(query_options)}"
-        end      
-    
-        def collection_path(prefix_options = {}, query_options = nil)
-          prefix_options, query_options = split_options(prefix_options) if query_options.nil?
-          raise(ActiveResource::MissingPrefixParam, ":blog_guid prefix_option is missing") unless prefix_options[:blog_guid] && defined?(ActiveResource::MissingPrefixParam)
-          "#{prefix(prefix_options)}#{prefix_options[:blog_guid].to_s}/#{collection_name}.#{format.extension}#{query_string(query_options)}"
-        end      
-    
-        private
-    
-        def prefix_parameters
-          @prefix_parameters ||= begin
-            params = super
-            params << :blog_guid
-            params
-          end
-        end 
-      end        
-    end
-    
-  end
-end

data/app/models/hubspot/blogs/comment.rb

@@ -1,5 +0,0 @@
-module Hubspot
-  module Blogs
-    class Comment < Hubspot::Blogs::BlogAssociation; end
-  end
-end

data/app/models/hubspot/blogs/post.rb

@@ -1,12 +0,0 @@
-module Hubspot
-  module Blogs
-    class Post < Hubspot::Blogs::BlogAssociation
-      
-      # Convenience method for retrieving a post's comments
-      def comments(params = {})
-        Hubspot::Blogs::Posts::Comment.find :all, :params => params.merge(:post_guid => guid)
-      end
-    
-    end
-  end
-end

data/app/models/hubspot/blogs/posts/comment.rb

@@ -1,23 +0,0 @@
-module Hubspot
-  module Blogs
-    module Posts
-    
-      # This type of Comment will be instantiated when finding comments that belong to Posts
-      class Comment < Hubspot::Base
-        self.site = 'https://api.hubapi.com/blog/v1/posts/:post_guid'
-      
-        alias_attribute :id, :guid
-        
-        class << self
-          
-          def collection_path(prefix_options = {}, query_options = nil)
-            prefix_options, query_options = split_options(prefix_options) if query_options.nil?
-            "#{prefix(prefix_options)}comments.#{format.extension}#{query_string(query_options)}"
-          end           
-          
-        end
-      end
-      
-    end
-  end
-end

data/app/models/hubspot/connection.rb

@@ -1,46 +0,0 @@
-module Hubspot
-
-  class Connection < ActiveResource::Connection
-    
-    # Set default parameters to send along with each request
-    def self.default_parameters
-      @default_parameters ||= begin
-        default_parameter_hash = {}
-        default_parameter_hash['portalId'] = Hubspot.config.hubspot_portal_id
-        
-        if Hubspot.config.hubspot_access_token.present?
-          default_parameter_hash['access_token'] = Hubspot.config.hubspot_access_token
-        else
-          default_parameter_hash['hapikey'] = Hubspot.config.hubspot_key
-        end
-        
-        default_parameter_hash
-      end
-    end
-    
-    # Override to support debug output
-    def configure_http(http)
-      http.set_debug_output(Hubspot.config.debug_http_output) if Hubspot.config.debug_http_output
-      super
-    end 
-  
-  private
-  
-    # Makes a request to the remote service and appends the default parameters
-    def request(method, path, *arguments)  
-      uri = URI.parse(path)
-
-      Hubspot::Connection.default_parameters.to_param.tap do |default_parameters|
-        if uri.query.present?
-          uri.query += '&' + default_parameters
-        else
-          uri.query = default_parameters
-        end
-      end
-      
-      super(method, uri.to_s, *arguments)
-    end
-       
-  end
-
-end

data/app/models/hubspot/event.rb

@@ -1,39 +0,0 @@
-module Hubspot
-  
-  # Finds and updates events
-  #
-  # Finds:
-  # Hubspot::Event.find :all, :params => { :max => 5 }
-  #
-  # Creates:
-  # Hubspot::Event.create(:eventType => 'new event', :description => 'test', :url => 'http://dev.hubspot.com', :createDate => '1323272544000' )
-  class Event < Hubspot::Base
-    self.site = 'https://api.hubapi.com/events/v1'
-    
-    schema do
-      string 'description', 'eventType', 'url', 'createDate'
-    end
-    
-    class << self
-      def create attributes
-        create!(attributes) #rescue false
-      end
-            
-      def create! attributes
-        return Hubspot::Event.post('events', attributes).code.to_i
-      end
-      
-      def custom_method_collection_url(method_name, options = {})
-        prefix_options, query_options = split_options(options)
-        "#{prefix(prefix_options)}#{method_name}#{query_string(query_options)}"
-      end
-      
-      def collection_path(prefix_options = {}, query_options = nil)
-        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
-        "#{prefix(prefix_options)}#{collection_name}#{query_string(query_options)}"
-      end      
-    end
-  
-  end
-  
-end