insightexchange 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5392c62d19d3e6764918a859ced2d12237d48d1a
+  data.tar.gz: 5613ec309b1c5673f4f1883c3cc3480ec0c64218
+SHA512:
+  metadata.gz: 13bfaa9b3b12e8ce48a2cf5c739d0f31220d00908820f8b0b2f38e2ebb6dc7dfffdba38c3de6441e8b962516bb466a5c66e7ee893ada122caf863e0f1c45eef4
+  data.tar.gz: 84c5612a1f5e49a85fa8159da48a35028262a4bfcef729f3898aff462b6e4c75486a6b8ae183563c37112fa0d13b6156909b9846eae0379b178c100e876bb4a5

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+insightexchange

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Liberatus Software, LLC
+
+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,50 @@
+# InsightExchange Ruby Gem
+
+This is a simple wrapper gem for the InsightExchange REST API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'insightexchange'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install insightexchange
+
+## Usage
+
+Instantiate a new client, providing the API token either through an environment variable or as an argument.
+
+```ruby
+exchange = InsightExchange.new #reads from ENV['INSIGHT_EXCHANGE_TOKEN']
+exchange.publish user.email, 'CookedDinner'
+# This will publish the insight and do one of the following.
+#  1. If it is a new type of insight, it will be submitted for approval
+#      first before being sent to anyone else.
+#  2. If we have already approved insights by that title, it will
+#      auction the insight off to the highest bidder that you have
+#      accepted.
+#  
+```
+
+Also, identify users early on in your registration flow to ensure breadth of coverage on the market.
+
+```ruby
+exchange.identify user.email
+```
+
+Please see the InsightExchange documentation for further details.
+http://insightexchange.co/for_developers/docs
+
+## Contributing
+
+1. Fork it ( https://github.com/insightexchange/insightexchange/fork )
+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 a new Pull Request

data/Rakefile

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

data/insightexchange.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'insightexchange/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "insightexchange"
+  spec.version       = InsightExchange::VERSION
+  spec.authors       = ["winfred"]
+  spec.email         = ["winfred@liberat.us"]
+  spec.summary       = %q{This is a tiny wrapper for the InsightExchange.co REST api.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+end

data/lib/insightexchange/version.rb

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

data/lib/insightexchange.rb

@@ -0,0 +1,59 @@
+require 'insightexchange/version'
+require 'httparty'
+
+class InsightExchange
+  include ::HTTParty
+  base_uri 'https://secure.insightexchange.co/sellers/api'
+  format :json
+
+  class MissingTokenError < RuntimeError; end
+
+  attr_accessor :api_token
+
+  def initialize(api_token = ENV['INSIGHT_EXCHANGE_TOKEN'])
+    self.api_token = api_token
+  end
+
+  def publish(email_address, insight_name, data = {})
+    ensure_api_token!
+    ensure_insight_name!(insight_name)
+    ensure_email_address!(email_address)
+
+    self.class.post("/insights.json", body: {
+        api_token: api_token,
+        insight: {
+          email: email_address,
+          name: insight_name,
+          data: data
+        }
+    })
+  end
+
+  def identify(email_address)
+    ensure_api_token!
+    ensure_email_address!(email_address)
+
+    self.class.post("/users.json", body: {
+        api_token: api_token,
+        user: {
+            email: email_address
+        }
+    })
+  end
+
+  private
+
+    def ensure_api_token!
+      if api_token.nil? || api_token.length == 0
+        raise MissingTokenError.new('No API token was provided for InsightExchange, either through an ENV variable or the client initializer.')
+      end
+    end
+
+    def ensure_email_address!(email_address)
+      raise ArgumentError.new('missing email address') unless email_address && email_address.length > 1
+    end
+
+    def ensure_insight_name!(insight_name)
+      raise ArgumentError.new('missing insight name') unless insight_name && insight_name.length > 1
+    end
+end

data/spec/insightexchange_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe InsightExchange do
+  let(:api_token) { 'abc123' }
+  let(:exchange) { InsightExchange.new(api_token) }
+
+  describe 'reading options from ENV variables' do
+    before { ENV['INSIGHT_EXCHANGE_TOKEN'] = api_token }
+    after { ENV['INSIGHT_EXCHANGE_TOKEN'] = nil }
+
+    it 'reads INSIGHT_EXCHANGE_TOKEN' do
+      client = InsightExchange.new
+      expect(client.api_token).to eql(api_token)
+    end
+  end
+
+  describe '#publish' do
+    let(:request_body) { 'api_token=abc123&insight[email]=this_email%40that_address.com&insight[name]=CreatedPopularPoem' }
+
+    describe 'when valid inputs' do
+      it 'POSTS to InsightExchange api' do
+        stub_request(:post, 'https://secure.insightexchange.co/sellers/api/insights.json').
+            with(:body => request_body).
+            to_return(:status => 200, :body => "", :headers => {})
+
+        exchange.publish 'this_email@that_address.com', 'CreatedPopularPoem'
+
+        assert_requested(:post, 'https://secure.insightexchange.co/sellers/api/insights.json') do
+          request_body
+        end
+      end
+
+      it 'POSTS arbitrary data' do
+        request_body = 'api_token=abc123&insight[email]=this_email%40that_address.com&insight[name]=CreatedPopularPoem&insight[data][arbitrary]=data'
+
+        stub_request(:post, 'https://secure.insightexchange.co/sellers/api/insights.json').
+            with(:body => request_body).
+            to_return(:status => 200, :body => "", :headers => {})
+
+        exchange.publish 'this_email@that_address.com', 'CreatedPopularPoem', arbitrary: 'data'
+
+        assert_requested(:post, 'https://secure.insightexchange.co/sellers/api/insights.json') do
+          request_body
+        end
+      end
+    end
+
+    describe 'when invalid inputs' do
+
+      it 'raises when missing api_token' do
+        expect {
+          InsightExchange.new.publish 'this_email@that_address.com', 'CreatedPopularPoem'
+        }.to raise_error(InsightExchange::MissingTokenError)
+      end
+
+      it 'raises when missing email_address' do
+        expect {
+          exchange.publish '', 'SomeInsight'
+        }.to raise_error(ArgumentError)
+      end
+
+      it 'raises when missing insight_name' do
+        expect {
+          exchange.publish 'this_email@that_address.com', ''
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#identify' do
+
+    describe 'when valid inputs' do
+      let(:request_body) { 'api_token=abc123&user[email]=this_email%40that_address.com' }
+
+      it 'POSTS to InsightExchange api' do
+        stub_request(:post, 'https://secure.insightexchange.co/sellers/api/users.json').
+            with(:body => request_body).
+            to_return(:status => 200, :body => "", :headers => {})
+
+        exchange.identify 'this_email@that_address.com'
+
+        assert_requested(:post, 'https://secure.insightexchange.co/sellers/api/users.json') do
+          request_body
+        end
+      end
+    end
+
+    describe 'when invalid inputs' do
+
+      it 'raises when missing api_token' do
+        expect {
+          InsightExchange.new.identify 'this_email@that_address.com'
+        }.to raise_error(InsightExchange::MissingTokenError)
+      end
+
+      it 'raises when missing email_address' do
+        expect {
+          exchange.identify ''
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'pry'
+require 'webmock/rspec'
+
+require 'insightexchange'
+
+
+RSpec.configure do |config|
+  # some (optional) config here
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: insightexchange
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- winfred
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: webmock
+  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'
+description: 
+email:
+- winfred@liberat.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- insightexchange.gemspec
+- lib/insightexchange.rb
+- lib/insightexchange/version.rb
+- spec/insightexchange_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: This is a tiny wrapper for the InsightExchange.co REST api.
+test_files:
+- spec/insightexchange_spec.rb
+- spec/spec_helper.rb