hubspot_informer 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODkzODI2NzZjNGZmOTE1ZjQ5ZTM1MTI0NGIwMjAxZDA1MDhhMmIzYw==
+  data.tar.gz: !binary |-
+    MTYwZmJlYTFjNjYzMTQ5YTUxMmIyZGUzZGJiZDM3NDkyZGY5MGU2Nw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    N2NjNTZiZDNiZGMwOTFmYTkyNTJiNDA0YjhkY2Q1OGU4YzcwMDg4MmY0ZmZm
+    MTA2OWZjNGY4MWNjNzQyYTM0MjQ1NWRiYzI1OTVjYzJmMzFkNWE2ZjA5ZWU4
+    OTZjNTQzYjUyMDFhYjYzYTY4YzRiOThlZDY1ODFlNTE0NmYyYzc=
+  data.tar.gz: !binary |-
+    ZDA2YjMwNjI1Mzg1YzNhZGE3N2FlNDg4ZGM5ZGExYWIzYWE4M2I1Y2JlYzUy
+    NjhkODE5YWFmMmJmMjVmZDliYWVhNmUwNTI4OTYxNWJhYzFjMjQ1ZjYyZmRh
+    Yzk4MWIzYjk3MzUxYTdkNGQyNzdkOGRkNWFhZjZkNjY5NTdlY2I=

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hubspot_informer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Henrik Sjökvist
+
+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,27 @@
+# HubSpot Informer for Ruby
+
+A simple API wrapper for HubSpot form submission API.
+
+## Usage
+
+### In Rails
+
+    hubspot = HubspotInformer.new(
+      # These are mandatory
+      portal_id: 1234,
+      form_guid: 567890,
+      # These are optional
+      request_ip: request.remote_ip,
+      hutk: cookies[:hutk],
+      page_url: "#{request.protocol}#{request.host_with_port}#{request.fullpath}"
+      page_title: @title
+      )
+    hubspot.submit params
+
+## 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,9 @@
+#!/usr/bin/env rake
+require 'bundler/setup';
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+Bundler.setup(:default, :development)
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/hubspot_informer.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hubspot_informer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "hubspot_informer"
+  gem.version       = HubspotInformer::VERSION
+  gem.authors       = ["Henrik Sjökvist"]
+  gem.email         = ["henrik.sjokvist@gmail.com"]
+  gem.description   = %q{A simple API wrapper for the HubSpot form submission API.}
+  gem.summary       = %q{A simple API wrapper for the HubSpot form submission API. 
+                         A typical use case is adding subcribers to a mailing list.}
+  gem.homepage      = "http://github.com/kollegorna/hubspot_informer"
+  gem.license       = 'MIT'
+
+  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.rubyforge_project = "hubspot_informer"
+
+  # Dependencies
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "vcr"
+  gem.add_runtime_dependency     "faraday"
+end

data/lib/hubspot_informer/version.rb

@@ -0,0 +1,3 @@
+class HubspotInformer
+  VERSION = "0.0.1"
+end

data/lib/hubspot_informer.rb

@@ -0,0 +1,49 @@
+require 'hubspot_informer/version'
+require 'faraday'
+require 'uri'
+require 'json'
+
+class HubspotInformer
+  HubspotInformerError = Class.new(StandardError)
+  def initialize args
+    args.each do |k,v|
+      instance_variable_set("@#{k}", v) unless v.nil?
+    end
+    @page_url ||= ''
+    @request_ip ||= ''
+    @hutk ||= ''
+    @page_title ||= ''
+
+    raise HubspotInformerError.new(
+      "HubspotInformer API Error: Missing portal_id and/or form_guid"
+      ) unless @portal_id && @form_guid
+
+    base_url = "https://forms.hubspot.com/"
+    @conn = Faraday.new(
+      url:      base_url,
+      ssl:      { verify: false },
+      headers:  { accept: 'application/json' })
+  end
+
+  def submit params
+    params[:hs_context] = hs_context
+    response = @conn.post do |req|
+      req.url "uploads/form/v2/#{@portal_id}/#{@form_guid}"
+      req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+      req.body = URI.encode_www_form params
+    end
+    unless response.status == 204
+      raise HubspotInformerError.new("HubspotInformer API Error: #{response.body} (status code #{response.status})")
+    end
+  end
+
+  def hs_context
+    values = {
+      'hutk' => @hutk,
+      'ipAddress' => @request_ip,
+      'pageUrl' => @page_url,
+      'pageTitle' => @page_title
+    }
+    values.to_json
+  end
+end

data/spec/fixtures/vcr/add_subscriber.yml

@@ -0,0 +1,34 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://forms.hubspot.com/uploads/form/v2/<PORTAL_ID>/<FORM_GUID>
+    body:
+      encoding: US-ASCII
+      string: firstname=John&lastname=Doe&email=john.doe%40example.com&hs_context=%7B%22hutk%22%3A%22%22%2C%22ipAddress%22%3A%22%22%2C%22pageUrl%22%3A%22%22%2C%22pageTitle%22%3A%22%22%7D
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - Faraday v0.8.6
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 204
+      message: 
+    headers:
+      access-control-allow-credentials:
+      - 'false'
+      date:
+      - Wed, 10 Apr 2013 13:33:48 GMT
+      server:
+      - Apache-Coyote/1.1
+      connection:
+      - Close
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Wed, 10 Apr 2013 13:33:42 GMT
+recorded_with: VCR 2.4.0

data/spec/fixtures/vcr/raise_exception.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://forms.hubspot.com/uploads/form/v2/<PORTAL_ID>/thisisnogood
+    body:
+      encoding: US-ASCII
+      string: firstname=John&lastname=Doe&email=john.doe%40example.com&hs_context=%7B%22hutk%22%3A%22%22%2C%22ipAddress%22%3A%22%22%2C%22pageUrl%22%3A%22%22%2C%22pageTitle%22%3A%22%22%7D
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - Faraday v0.8.6
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 404
+      message: 
+    headers:
+      access-control-allow-credentials:
+      - 'false'
+      content-type:
+      - text/html;charset=utf-8
+      date:
+      - Wed, 10 Apr 2013 11:55:33 GMT
+      server:
+      - Apache-Coyote/1.1
+      content-length:
+      - '952'
+      connection:
+      - Close
+    body:
+      encoding: US-ASCII
+      string: ! '<html><head><title>Apache Tomcat/6.0.30 - Error report</title><style><!--H1
+        {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:22px;}
+        H2 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:16px;}
+        H3 {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;font-size:14px;}
+        BODY {font-family:Tahoma,Arial,sans-serif;color:black;background-color:white;}
+        B {font-family:Tahoma,Arial,sans-serif;color:white;background-color:#525D76;}
+        P {font-family:Tahoma,Arial,sans-serif;background:white;color:black;font-size:12px;}A
+        {color : black;}A.name {color : black;}HR {color : #525D76;}--></style> </head><body><h1>HTTP
+        Status 404 - </h1><HR size="1" noshade="noshade"><p><b>type</b> Status report</p><p><b>message</b>
+        <u></u></p><p><b>description</b> <u>The requested resource () is not available.</u></p><HR
+        size="1" noshade="noshade"><h3>Apache Tomcat/6.0.30</h3></body></html>'
+    http_version: 
+  recorded_at: Wed, 10 Apr 2013 11:55:30 GMT
+recorded_with: VCR 2.4.0

data/spec/hubspot_informer_spec.rb

@@ -0,0 +1,39 @@
+require 'vcr'
+require 'faraday'
+require_relative 'support/vcr'
+require_relative '../lib/hubspot_informer.rb'
+
+
+unless ENV['HUBSPOT_TEST_PORTAL_ID'] && ENV['HUBSPOT_TEST_FORM_GUID']
+  warn ["WARNING: You need to set the HUBSPOT_TEST_PORTAL_ID and HUBSPOT_TEST_FORM_GUID",
+    "environment variables or the calls to the HubSpot API will be invalid."].join("\n")
+end
+
+describe "HubspotInformer" do
+  it "adds a subscriber to a list" do
+    VCR.use_cassette('add_subscriber') do
+      portal_id = ENV['HUBSPOT_TEST_PORTAL_ID']
+      form_guid = ENV['HUBSPOT_TEST_FORM_GUID']
+      hubspot = HubspotInformer.new(
+        portal_id: portal_id,
+        form_guid: form_guid,
+      )
+      params = { firstname: 'John', lastname: 'Doe', email: 'john.doe@example.com' }
+      response = hubspot.submit params
+      response.should eql nil
+    end
+  end
+
+  it "raises an exception when an error HTTP status code is returned" do
+    VCR.use_cassette('raise_exception') do
+      portal_id = ENV['HUBSPOT_TEST_PORTAL_ID']
+      form_guid = 'thisisnogood'
+      hubspot = HubspotInformer.new(
+        portal_id: portal_id,
+        form_guid: form_guid,
+      )
+      params = { firstname: 'John', lastname: 'Doe', email: 'john.doe@example.com' }
+      lambda { hubspot.submit params }.should raise_error(HubspotInformer::HubspotInformerError)
+    end
+  end
+end

data/spec/support/vcr.rb

@@ -0,0 +1,7 @@
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr'
+  c.hook_into :faraday
+  c.filter_sensitive_data('<PORTAL_ID>') { ENV['HUBSPOT_TEST_PORTAL_ID'] }
+  c.filter_sensitive_data('<FORM_GUID>') { ENV['HUBSPOT_TEST_FORM_GUID'] }
+end
+

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: hubspot_informer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Henrik Sjökvist
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple API wrapper for the HubSpot form submission API.
+email:
+- henrik.sjokvist@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hubspot_informer.gemspec
+- lib/hubspot_informer.rb
+- lib/hubspot_informer/version.rb
+- spec/fixtures/vcr/add_subscriber.yml
+- spec/fixtures/vcr/raise_exception.yml
+- spec/hubspot_informer_spec.rb
+- spec/support/vcr.rb
+homepage: http://github.com/kollegorna/hubspot_informer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: hubspot_informer
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A simple API wrapper for the HubSpot form submission API.  A typical use
+  case is adding subcribers to a mailing list.
+test_files:
+- spec/fixtures/vcr/add_subscriber.yml
+- spec/fixtures/vcr/raise_exception.yml
+- spec/hubspot_informer_spec.rb
+- spec/support/vcr.rb