woopra_rails 1.1.10 → 1.2

data/lib/woopra_rails/api.rb

@@ -1,20 +1,7 @@
 module WoopraRails
   class << self
-    def identify(name="", email="")
-      name = begin
-        URI::encode name
-      rescue
-        ""
-      end
-
-      email = begin
-        URI::encode email
-      rescue 
-        ""
-      end
-      
-      action = "&ce_name=identified&cv_name=#{name}&cv_email=#{email}"
-      ::Rails.logger.debug("User info: #{name.inspect}, #{email.inspect}")
+    def identify(name, email, ip)
+      action = "&ip=#{URI::encode ip}&ce_name=identified&cv_name=#{URI::encode name}&cv_email=#{URI::encode email}"
       issue_request(action)
     end
 
@@ -41,6 +28,7 @@ module WoopraRails
         ""
       end
       action = "&cv_name=#{name}&cv_email=#{email}&ce_name=#{event_name}"
+      action += "&ip=#{URI::encode args.delete(:ip)}"
 
       args.each do |k,v|
         action += "&ce_#{k}=#{URI::encode v.to_s}"
@@ -50,11 +38,10 @@ module WoopraRails
     end
 
     def issue_request(action=nil)
-      action = action.nil? ? @base_params : @base_params + action
+      action = action.nil? ? base_params : base_params + action
       uri = URI.parse(action)
-      resp = WoopraRails::Response.new(dryrun ? nil : Net::HTTP.get(uri))
-      return resp if resp.success?
-      raise WoopraError
+      resp = dryrun ? nil : Net::HTTP.get(uri)
+      WoopraRails::Response.new.parse(resp)
     end
   end
 end

data/lib/woopra_rails/engine.rb

@@ -2,8 +2,11 @@ module WoopraRails
   module Rails
     class Engine < ::Rails::Engine
       initializer "woopra_rails.load_config" do |app|
-        WoopraRails.config = YAML.load_file(app.root.join("config","woopra.yml"))[::Rails.env]
-        WoopraRails.init
+        if File.exists? "#{app.root}/config/woopra.yml"
+          WoopraRails.config = YAML.load_file(app.root.join("config","woopra.yml"))[::Rails.env]
+        else
+          raise WoopraError, "Missing woopra.yml in Rails root config directory."
+        end
       end
     end
   end

data/lib/woopra_rails/error.rb

@@ -1,2 +1,19 @@
 class WoopraError < StandardError
-end
+  class << self
+    def json_exception?(e)
+      e.class == JSON::ParserError
+    end
+
+    def account_exception?(json)
+      ["host", "not registered!"].all?{|w| json.downcase.include? w }
+    end
+
+    def get_error(e, json)
+      if json_exception?(e) && account_exception?(json)
+        raise WoopraError, "Your account is incorrect.  Woopra responded that '#{WoopraRails.account}'' was not registered."
+      elsif json_exception?(e)
+        ::Rails.logger.debug("JSON::ParserError in WoopraRails.  Not raising, but you should check.")
+      end
+    end
+  end
+end

data/lib/woopra_rails/response.rb

@@ -1,16 +1,18 @@
-module WoopraRails::Response
-  class << self
+module WoopraRails
+  class Response
     attr_accessor :success
-    def new(json=nil)
-      if json
-        begin
-          JSON.parse(json).each do |k,v|
-            self.send("#{k}=".to_sym, v)
-          end  
-        rescue Exception => e
-          self.send("success=", 1)
-        end
-        
+    def new()
+      success = false
+    end
+
+    def parse(json=nil)
+      begin
+        JSON.parse(json).each do |k,v|
+          self.send("#{k}=".to_sym, v)
+        end  
+      rescue Exception => e
+        WoopraError.get_error(e, json)
+        send("success=", false)
       end
       self
     end

data/lib/woopra_rails/version.rb

@@ -1,3 +1,3 @@
 module WoopraRails
-  VERSION = "1.1.10"
+  VERSION = "1.2"
 end

data/lib/woopra_rails.rb

@@ -12,32 +12,36 @@ require 'fileutils'
 ].each{ |f| require "woopra_rails/#{f}" }
 
 module WoopraRails
-  @endpoint     = 'http://www.woopra.com/track/ce/'
-  @dryrun       = false
-  @config       = {}
-  @env          = "development"
-  @base_params  = ""
+  @config = {}
 
   class << self
     def config=(config)
       @config = config
     end
 
-    def init
-      begin
-        @env = ::Rails.env if defined? Rails
-        @base_params = "#{@endpoint}?host=#{account}&response=json&timeout=300000"
-      rescue Exception => e
-        puts("Error on init: #{e.message}")
-      end
+    def config
+      @config
     end
 
     def dryrun
-      return @config["dryrun"] == true
+      @config["dryrun"]
     end
 
     def account
       @config["account"]
     end
+
+    def env
+      return ::Rails.env if defined? Rails
+      ""
+    end
+
+    def endpoint
+      'http://www.woopra.com/track/ce/'
+    end
+
+    def base_params
+      "#{endpoint}?host=#{account}&response=json&timeout=300000"
+    end
   end
 end

data/spec/TestApp/.rspec

@@ -0,0 +1 @@
+--color

data/spec/TestApp/Gemfile

@@ -1,7 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'rails', '3.2.12'
-gem 'woopra_rails', path: "../../", require: 'woopra_rails'
 gem 'sqlite3'
 gem 'jquery-rails'
 
@@ -25,7 +24,8 @@ group :test do
   gem 'simplecov', :require => false, :group => :test
 end
 
-group :test, :dp, :development do
+group :test, :development do
+  gem 'woopra_rails', path: "../../", require: 'woopra_rails'
   gem 'rspec-rails', '~> 2.13.0'
   gem 'factory_girl_rails'
   gem 'debugger'

data/spec/TestApp/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/spec/TestApp/app/controllers/application_controller.rb

@@ -1,6 +1,5 @@
 class ApplicationController < ActionController::Base
   protect_from_forgery
-  include WoopraRails::Session
 
   def index
     

data/spec/TestApp/fixtures/cassettes/failed.yml

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://www.woopra.com/track/ce/?ce_name=identified&cv_email=me@wooprauser&cv_name=woopra%20user&host=topgun.dp.generalassemb.ly.test&response=json&timeout=300000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Length:
+      - '58'
+      Connection:
+      - close
+      Server:
+      - Jetty(8.1.8.v20121106)
+    body:
+      encoding: US-ASCII
+      string: ! '/*
+
+        Host topgun.dp.generalassemb.ly.test not registered!
+
+        */'
+    http_version: 
+  recorded_at: Tue, 07 May 2013 21:26:57 GMT
+- request:
+    method: get
+    uri: http://www.woopra.com/track/ce/?ce_name=identified&cv_email=me@wooprauser&cv_name=woopra%20user&host=topgun.dp.generalassemb.ly&response=json&timeout=300000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Content-Type:
+      - text/javascript; charset=utf-8
+      Server:
+      - woopra-d-7.1b
+      Pragma:
+      - no-cache
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Content-Length:
+      - '13'
+      Connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! '{"success":1}'
+    http_version: 
+  recorded_at: Tue, 07 May 2013 21:58:50 GMT
+recorded_with: VCR 2.4.0

data/spec/TestApp/fixtures/cassettes/success-bad-email.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://www.woopra.com/track/ce/?ce_name=identified&cv_email=me@wooprauser&cv_name=woopra%20user&host=topgun.dp.generalassemb.ly&response=json&timeout=300000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Content-Type:
+      - text/javascript; charset=utf-8
+      Server:
+      - woopra-d-7.1b
+      Pragma:
+      - no-cache
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Content-Length:
+      - '13'
+      Connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! '{"success":1}'
+    http_version: 
+  recorded_at: Tue, 07 May 2013 22:01:47 GMT
+recorded_with: VCR 2.4.0

data/spec/TestApp/fixtures/cassettes/success-good-arguments.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://www.woopra.com/track/ce/?ce_name=identified&cv_email=me@wooprauser.com&cv_name=woopra%20user&host=topgun.dp.generalassemb.ly&response=json&timeout=300000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Content-Type:
+      - text/javascript; charset=utf-8
+      Server:
+      - woopra-d-7.1b
+      Pragma:
+      - no-cache
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Content-Length:
+      - '13'
+      Connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! '{"success":1}'
+    http_version: 
+  recorded_at: Tue, 07 May 2013 22:01:47 GMT
+recorded_with: VCR 2.4.0

data/spec/TestApp/fixtures/cassettes/success.yml

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://www.woopra.com/track/ce/?ce_name=identified&cv_email=me@wooprauser.com&cv_name=woopra%20user&host=topgun.dp.generalassemb.ly.test&response=json&timeout=300000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Length:
+      - '58'
+      Connection:
+      - close
+      Server:
+      - Jetty(8.1.8.v20121106)
+    body:
+      encoding: US-ASCII
+      string: ! '/*
+
+        Host topgun.dp.generalassemb.ly.test not registered!
+
+        */'
+    http_version: 
+  recorded_at: Tue, 07 May 2013 21:25:24 GMT
+- request:
+    method: get
+    uri: http://www.woopra.com/track/ce/?ce_name=identified&cv_email=me@wooprauser.com&cv_name=woopra%20user&host=topgun.dp.generalassemb.ly&response=json&timeout=300000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Content-Type:
+      - text/javascript; charset=utf-8
+      Server:
+      - woopra-d-7.1b
+      Pragma:
+      - no-cache
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Content-Length:
+      - '13'
+      Connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! '{"success":1}'
+    http_version: 
+  recorded_at: Tue, 07 May 2013 21:58:50 GMT
+recorded_with: VCR 2.4.0

data/spec/TestApp/spec/lib/api_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe WoopraRails do
+  context "expected current api methods" do
+    it "should have respond to 'identify'" do
+      WoopraRails.respond_to?(:identify).should be_true
+    end
+
+    it "should respond to 'log_pageview'" do
+      WoopraRails.respond_to?(:log_pageview).should be_true
+    end
+
+    it "should respond to 'record'" do
+      WoopraRails.respond_to?(:record).should be_true
+    end
+  end
+
+  context "#identify" do
+    it "should raise an argument error when nothing is passed" do
+      expect {
+        WoopraRails.identify
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should raise an argument error with a message when not passing a name" do
+      expect {
+        WoopraRails.identify
+      }.to raise_error(ArgumentError, "You must identify with a name")
+    end
+
+    it "should raise an argument error with a message when not passing an email" do
+      expect {
+        WoopraRails.identify("woopra user")
+      }.to raise_error(ArgumentError, "You must identify with an email")
+    end
+
+    it "should return a WoopraRails::Response object" do
+      vcr "success" do
+        WoopraRails.identify("woopra user", "me@wooprauser.com").class.should == WoopraRails::Response
+      end
+    end
+
+    it "should return a successful response with valid arguments" do
+      vcr "success-good-arguments" do
+        WoopraRails.identify("woopra user", "me@wooprauser.com").success?.should be_true
+      end
+    end
+
+    it "should return a successful response and not check validity of email" do
+      vcr "success-bad-email" do
+        WoopraRails.identify("woopra user", "me@wooprauser").success?.should be_true
+      end
+    end
+  end
+end

data/spec/TestApp/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../../config/environment", __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+require 'webmock/rspec'
+require 'vcr'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end
+
+CONFIG_YML = YAML::load_file(File.join(File.dirname(File.expand_path(__FILE__)), '../config/woopra.yml'))

data/spec/TestApp/spec/support/vcr.rb

@@ -0,0 +1,8 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = "fixtures/cassettes"
+  c.hook_into :webmock
+  c.ignore_localhost = true
+  c.default_cassette_options = { record: :new_episodes }
+end

data/spec/TestApp/spec/support/vcr_macros.rb

@@ -0,0 +1,7 @@
+require 'vcr'
+
+def vcr(cassette, record=:none)
+  VCR.use_cassette(cassette, record: record) do
+    yield 
+  end
+end

data/spec/TestApp/spec/woopra_rails_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe WoopraRails do
+  it "should define module instance var for @config" do
+    WoopraRails.instance_variables.include?(:@config).should be_true
+  end
+
+  it "should have a valid environment" do
+    WoopraRails.env.should == Rails.env
+  end
+
+  it "should have an endpoint" do
+    WoopraRails.endpoint.should == "http://www.woopra.com/track/ce/"
+  end
+
+  it "should have dryrun set to the value in the config file" do
+    WoopraRails.dryrun.should == CONFIG_YML[::Rails.env.to_s]["dryrun"]
+  end
+
+  it "should have account set to the value in the config file" do
+    WoopraRails.account.should == CONFIG_YML[::Rails.env.to_s]["account"]
+  end
+
+  it "should respond with a valid URI for base params" do
+    WoopraRails.base_params.should == URI.encode(WoopraRails.base_params)
+  end
+
+  it "should include always necesary params in base params" do
+    ["host","response","timeout"].each do |p|
+      WoopraRails.base_params.include?(p).should be_true
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: woopra_rails
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: '1.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-07 00:00:00.000000000 Z
+date: 2013-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,7 +63,9 @@ files:
 - lib/woopra_rails/response.rb
 - lib/woopra_rails/version.rb
 - spec/TestApp/.gitignore
+- spec/TestApp/.rspec
 - spec/TestApp/Gemfile
+- spec/TestApp/Guardfile
 - spec/TestApp/README.rdoc
 - spec/TestApp/Rakefile
 - spec/TestApp/app/assets/images/rails.png
@@ -93,6 +95,10 @@ files:
 - spec/TestApp/config/routes.rb
 - spec/TestApp/config/woopra.yml.example
 - spec/TestApp/db/seeds.rb
+- spec/TestApp/fixtures/cassettes/failed.yml
+- spec/TestApp/fixtures/cassettes/success-bad-email.yml
+- spec/TestApp/fixtures/cassettes/success-good-arguments.yml
+- spec/TestApp/fixtures/cassettes/success.yml
 - spec/TestApp/lib/assets/.gitkeep
 - spec/TestApp/lib/tasks/.gitkeep
 - spec/TestApp/log/.gitkeep
@@ -102,6 +108,11 @@ files:
 - spec/TestApp/public/favicon.ico
 - spec/TestApp/public/robots.txt
 - spec/TestApp/script/rails
+- spec/TestApp/spec/lib/api_spec.rb
+- spec/TestApp/spec/spec_helper.rb
+- spec/TestApp/spec/support/vcr.rb
+- spec/TestApp/spec/support/vcr_macros.rb
+- spec/TestApp/spec/woopra_rails_spec.rb
 - spec/TestApp/test/fixtures/.gitkeep
 - spec/TestApp/test/functional/.gitkeep
 - spec/TestApp/test/integration/.gitkeep
@@ -111,8 +122,6 @@ files:
 - spec/TestApp/vendor/assets/javascripts/.gitkeep
 - spec/TestApp/vendor/assets/stylesheets/.gitkeep
 - spec/TestApp/vendor/plugins/.gitkeep
-- spec/lib/woopra_rails_spec.rb
-- spec/spec_helper.rb
 - woopra_rails.gemspec
 homepage: http://github.com/khopkins218/woopra_rails
 licenses:
@@ -141,7 +150,9 @@ specification_version: 3
 summary: Server side integration of Woopra HTTP API for Ruby on Rails applications
 test_files:
 - spec/TestApp/.gitignore
+- spec/TestApp/.rspec
 - spec/TestApp/Gemfile
+- spec/TestApp/Guardfile
 - spec/TestApp/README.rdoc
 - spec/TestApp/Rakefile
 - spec/TestApp/app/assets/images/rails.png
@@ -171,6 +182,10 @@ test_files:
 - spec/TestApp/config/routes.rb
 - spec/TestApp/config/woopra.yml.example
 - spec/TestApp/db/seeds.rb
+- spec/TestApp/fixtures/cassettes/failed.yml
+- spec/TestApp/fixtures/cassettes/success-bad-email.yml
+- spec/TestApp/fixtures/cassettes/success-good-arguments.yml
+- spec/TestApp/fixtures/cassettes/success.yml
 - spec/TestApp/lib/assets/.gitkeep
 - spec/TestApp/lib/tasks/.gitkeep
 - spec/TestApp/log/.gitkeep
@@ -180,6 +195,11 @@ test_files:
 - spec/TestApp/public/favicon.ico
 - spec/TestApp/public/robots.txt
 - spec/TestApp/script/rails
+- spec/TestApp/spec/lib/api_spec.rb
+- spec/TestApp/spec/spec_helper.rb
+- spec/TestApp/spec/support/vcr.rb
+- spec/TestApp/spec/support/vcr_macros.rb
+- spec/TestApp/spec/woopra_rails_spec.rb
 - spec/TestApp/test/fixtures/.gitkeep
 - spec/TestApp/test/functional/.gitkeep
 - spec/TestApp/test/integration/.gitkeep
@@ -189,5 +209,3 @@ test_files:
 - spec/TestApp/vendor/assets/javascripts/.gitkeep
 - spec/TestApp/vendor/assets/stylesheets/.gitkeep
 - spec/TestApp/vendor/plugins/.gitkeep
-- spec/lib/woopra_rails_spec.rb
-- spec/spec_helper.rb

data/spec/lib/woopra_rails_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-describe WoopraRails do
-  context "post init" do
-    it "should define module instance vars" do
-      [:@endpoint, :@dryrun, :@config, :@env, :@base_params].each do |v|
-        WoopraRails.instance_variables.include?(v).should be_true
-      end
-    end  
-  end
-end

data/spec/spec_helper.rb

@@ -1,11 +0,0 @@
-ENV["RAILS_ENV"] ||= 'test'
-
-require 'rubygems'
-require 'rspec/autorun'
-require 'bundler/setup'
-require 'factory_girl_rails'
-require 'woopra_rails'
-
-RSpec.configure do |config|
-  config.include FactoryGirl::Syntax::Methods
-end