woopra_rails 1.0

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in woopra_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kevin L. Hopkins
+
+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,72 @@
+# WoopraRails
+
+A gem for Ruby on Rails (version 3 and higher, wont work with Rails 4) to connect through the HTTP API interface to log pageviews, identities, and custom events to Woopra Analytics
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'woopra_rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install woopra_rails
+
+## Initial setup
+  Within your app/config directory, add the file 'woopra.yml' that looks like the following (but with your account):
+
+    development:
+      account: woopra-rails
+      dryrun: true
+    test:
+      account: woopra-rails
+      dryrun: true
+    production:
+      account: woopra-rails
+      dryrun: false
+
+  At this point, Woopra should initialize on app load and be ready for usage.
+
+## Usage
+  All API actions return a WoopraRails::Response object.  To check for success, assign the return to a variable, e.g. response, and call success? for a boolean return
+    
+    response = WoopraRails.identify("me")
+    response.success? #returns true
+
+  Identify the current user:
+    
+    response = WoopraRails.identify("me@kevinlhopkins.com")
+  
+  Log a pageview:
+    
+    WoopraRails.log_pageview("Page Title", "/path/to/this/page")
+
+  Log a custom event:
+  This functionality is pretty extensible.  It expects an event name, and a hash of params that are turned into Woopra event descriptors.
+    
+    WoopraRails.log_event(
+      "my_test_event",
+      {
+        user_name: "Kevin Hopkins",
+        user_state: "Virginia",
+        user_skills: "Development, Rails, Woopra, Analytics"
+      }
+    )
+
+
+## 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
+
+## Contributions
+  Rob Gleeson -- Thanks for the help and code reviews! [Github](http://github.com/robgleeson)
+
+  GeneralAssemb.ly -- Thanks for the use-case to give me the opportunity to give back to the  Rails community (http://generalassemb.ly)

data/Rakefile

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

data/lib/woopra_rails.rb

@@ -0,0 +1,50 @@
+require "woopra_rails/version"
+require "woopra_rails/engine"
+require 'uri'
+require 'socket'
+require 'net/http'
+require 'fileutils'
+
+[
+  'version',
+  'engine',
+  'error',
+  'response',
+  'session',
+  'api'
+].each{ |f| require "woopra_rails/#{f}" }
+
+module WoopraRails
+  @endpoint     = 'http://www.woopra.com/track/ce/'
+  @dryrun       = false
+  @config       = {}
+  @env          = "development"
+
+  class << self
+    def config=(config)
+      @config = config
+    end
+
+    def get_env_config
+      @env = ::Rails.env if defined? Rails
+      set_base
+    end
+
+    def init
+      begin
+        get_env_config
+      rescue Exception => e
+        puts("Error on init: #{e.message}")
+      end
+    end
+
+    def set_base
+      @account = @config["account"]
+      @base_params = "#{@host}#{@endpoint}?host=#{account}&response=json&cookie=#{WoopraRails::Session.user_id}&timeout=300000"
+    end
+
+    def account
+      @config["account"]
+    end
+  end
+end

data/lib/woopra_rails/api.rb

@@ -0,0 +1,28 @@
+module WoopraRails
+  class << self
+    def identify(email)
+      @base_params += "&cv_name=#{email}"
+      issue_request
+    end
+
+    def log_pageview(title, url)
+      issue_request("&ce_name=pv&ce_title=#{URI::encode title}&ce_url=#{url}")
+    end
+
+    def log_event(event_name, args={})
+      action = "&ce_name=#{URI::encode event_name}"
+      args.each do |k,v|
+        action += "&ce_#{k}=#{URI::encode v}"
+      end
+      issue_request(action)
+    end
+
+    def issue_request(action=nil)
+      action = action.nil? ? @base_params : @base_params + action
+      uri = URI.parse(action)
+      resp = WoopraRails::Response.new(Net::HTTP.get(uri))
+      return resp if resp.success?
+      raise WoopraError
+    end
+  end
+end

data/lib/woopra_rails/engine.rb

@@ -0,0 +1,10 @@
+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
+      end
+    end
+  end
+end

data/lib/woopra_rails/error.rb

@@ -0,0 +1,2 @@
+class WoopraError < StandardError
+end

data/lib/woopra_rails/response.rb

@@ -0,0 +1,18 @@
+module WoopraRails::Response
+  class << self
+    attr_accessor :success
+    def new(json=nil)
+      if json
+        JSON.parse(json).each do |k,v|
+          self.send("#{k}=".to_sym, v)
+        end
+      end
+      self
+    end
+
+    def success?
+      return true if self.send(:success) == 1 || @dryrun
+      return false
+    end
+  end
+end

data/lib/woopra_rails/session.rb

@@ -0,0 +1,24 @@
+module WoopraRails::Session
+  extend ActiveSupport::Concern
+  included do
+    before_filter :set_or_use_woopra_cookie
+
+    def set_or_use_woopra_cookie
+      session[:woopra_user_id] = SecureRandom.hex(16) unless !session || session[:woopra_user_id]
+    end
+  end
+
+  class << self
+    def user_id
+      begin
+        session[:woopra_user_id]
+      rescue
+        ""
+      end
+    end
+
+    def page_path
+      request.url
+    end
+  end
+end

data/lib/woopra_rails/version.rb

@@ -0,0 +1,3 @@
+module WoopraRails
+  VERSION = "1.0"
+end

data/spec/TestApp/.gitignore

@@ -0,0 +1,16 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+config/woopra.yml

data/spec/TestApp/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.12'
+gem 'woopra_rails', path: "../../", require: 'woopra_rails'
+gem 'sqlite3'
+gem 'jquery-rails'
+gem 'pry-rails'

data/spec/TestApp/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.