preact 0.5.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011-2013 Christopher Gooley
+
+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/lib/preact/client.rb

@@ -0,0 +1,50 @@
+require 'multi_json'
+require 'rest_client'
+
+class Preact::Client
+    
+    def create_event(person, action_event)
+    	params = {
+        :person => person,
+        :event => action_event
+      }
+
+      data = post_request("/events", params)
+    end
+
+    def update_person(person)
+      params = {
+        :person => person
+      }
+
+      data = post_request("/people", params)
+    end
+    
+    private
+
+    def post_request(method, params={})
+      params = prepare_request_params(params)
+      
+      puts "post_request to #{Preact.configuration.base_uri + method} with #{params.inspect}"
+      
+      res = RestClient.post Preact.configuration.base_uri + method, params.to_json, :content_type => :json, :accept => :json
+      data = MultiJson.decode(res.body)
+    end
+
+    def get_request(method, params={})
+      params = prepare_request_params(params)
+      
+      res = RestClient.get Preact.configuration.base_uri + method, { :params => params }
+      data = MultiJson.decode(res.body)
+    end
+    
+    def prepare_request_params(params = {})
+      params.merge({
+        # :user => Preact.configuration.code,
+        # :password => Preact.configuration.secret,
+        :format => "json"
+      })
+    end
+    
+
+end

data/lib/preact/configuration.rb

@@ -0,0 +1,80 @@
+require 'preact/version'
+
+module Preact
+  class Configuration
+    
+    # Preact credentials
+    attr_accessor :code
+    attr_accessor :secret
+    
+    # Default option settings
+    attr_accessor :disabled
+    attr_accessor :person_builder
+    
+    # The URL of the API server
+    attr_accessor :scheme
+    attr_accessor :host
+    attr_accessor :base_path
+    
+    def initialize
+      @scheme = 'https'
+      @host = 'api.preact.io'
+      @base_path = '/api/v2'
+      
+      @disabled = false
+      @person_builder = nil
+      
+      @user_agent = "ruby-preact:#{Preact::VERSION}"
+    end
+    
+    def valid?
+      code && secret
+    end
+    
+    def enabled?
+      !disabled
+    end
+    
+    def disabled?
+      !!disabled
+    end
+    
+    def user_agent
+      @user_agent
+    end
+    
+    def base_uri
+      "#{scheme}://#{code}:#{secret}@#{host}#{base_path}"
+    end
+    
+    def convert_to_person(user)
+      if person_builder
+        if person_builder.respond_to?(:call)
+          Person.new(person_builder.call(user))
+        else
+          raise "person_builder must be callable"
+        end
+      elsif user.respond_to?(:to_person)
+        Person.new(user.to_person)
+      elsif user.is_a? Hash
+        Person.new(user)
+      else
+        Person.new(default_user_to_person_hash(user))
+      end
+    end
+    
+    private
+    
+    def default_user_to_person_hash(user)
+      {
+        :name => user.name,
+        :email => user.email,
+        :uid => user.id,
+        :properties => {
+          :created_at => (user.created_at.to_i if user.respond_to?(:created_at))
+        }
+      }
+    end
+
+  end
+end

data/lib/preact/objects/action_event.rb

@@ -0,0 +1,35 @@
+module Preact
+	class ActionEvent < Event
+
+    attr_accessor :note, :links, :external_identifier, :extras
+
+    def add_link(name, href)
+      self.links ||= []
+      self.links << ActionLink.new({ :name => name, :href => href })
+    end
+
+    def as_json(options={})
+      super(options).merge({
+        :klass => "actionevent",
+        :note => self.note,
+        :external_identifier => self.external_identifier,
+        :extras => self.extras,
+        :links => self.links.nil? ? nil : self.links.as_json
+      })
+    end
+
+	end
+
+	class ActionLink < ApiObject
+
+		attr_accessor :name, :href
+    
+    def as_json
+      {
+        :name => self.name,
+        :href => self.href
+      }
+    end
+
+	end
+end

data/lib/preact/objects/api_object.rb

@@ -0,0 +1,9 @@
+class Preact::ApiObject
+  
+  def initialize(args={})
+    args.each do |k,v|
+      instance_variable_set("@#{k}", v) unless v.nil?
+    end
+  end
+  
+end

data/lib/preact/objects/event.rb

@@ -0,0 +1,14 @@
+class Preact::Event < Preact::ApiObject
+  
+  attr_accessor :name, :magnitude, :timestamp
+
+  def as_json(options={})
+    {
+      :name      => self.name,
+      :magnitude => self.magnitude,
+      :timestamp => self.timestamp,
+      :source    => Preact.configuration.user_agent # version of this logging library
+    }
+  end
+
+end

data/lib/preact/objects/message.rb

@@ -0,0 +1,13 @@
+class Preact::Message < Preact::Event
+  
+  attr_accessor :subject, :body
+
+  def as_json(options={})
+    super(options).merge({
+      :klass => "message",
+      :subject => self.subject,
+      :body => self.body
+    })
+  end
+  
+end

data/lib/preact/objects/person.rb

@@ -0,0 +1,14 @@
+class Preact::Person < Preact::ApiObject
+    
+  attr_accessor :name, :email, :external_identifier, :properties, :uid
+    
+  def as_json(options={})
+    {
+      :name                => self.name,
+      :email               => self.email,
+      :uid                 => self.uid || self.external_identifier,
+      :properties          => self.properties
+    }
+  end
+    
+end

data/lib/preact/sidekiq/preact_logging_worker.rb

@@ -0,0 +1,15 @@
+module Preact::Sidekiq
+  class PreactLoggingWorker
+    include Sidekiq::Worker
+
+    def perform(person, event=nil)
+      client = Preact::Client.new
+      if event
+        client.create_event(person, event)
+      else
+        client.update_person(person)
+      end
+    end
+
+  end
+end

data/lib/preact/sidekiq.rb

@@ -0,0 +1,5 @@
+require 'preact/sidekiq/preact_logging_worker'
+
+module Preact::Sidekiq
+
+end

data/lib/preact/version.rb

@@ -0,0 +1,3 @@
+module Preact
+  VERSION = "0.5.0"
+end

data/lib/preact.rb

@@ -0,0 +1,84 @@
+require 'preact/configuration'
+require 'preact/client'
+
+require 'preact/objects/api_object'
+require 'preact/objects/person'
+require 'preact/objects/event'
+require 'preact/objects/action_event'
+require 'preact/objects/message'
+
+module Preact
+
+  class << self
+    # A Preact configuration object. Must like a hash and return sensible values for all
+    # Preact configuration options. See Preact::Configuration
+    attr_accessor :configuration
+    
+    attr_accessor :default_client
+
+    # Call this method to modify the configuration in your initializers
+    def configure
+      self.configuration ||= Configuration.new
+
+      yield(configuration) if block_given?
+      
+      raise StandardError.new "Must specify project code and secret when configuring the Preact api client" unless configuration.valid?
+    end
+    
+    def log_event(user, event_name, extras = {})
+      # Don't send requests when disabled
+      return if configuration.disabled?
+      return if user.nil?
+ 
+      person = configuration.convert_to_person(user).as_json
+      event = ActionEvent.new({
+          :name => event_name,
+          :timestamp => Time.now.to_f
+        }.merge(extras)).as_json
+
+      send_log(person, event)
+    end
+      
+    def update_person(user)
+      # Don't send requests when disabled
+      return if configuration.disabled?
+      return if user.nil?
+      
+      person = configuration.convert_to_person(user).as_json
+
+      send_log(person)
+    end
+    
+    # message - a Hash with the following required keys
+    #           :subject - subject of the message
+    #           :body - body of the message
+    #           * any additional keys are used as extra options for the message (:note, etc.)
+    def message(user, message = {})
+      # Don't send requests when disabled
+      return if configuration.disabled?
+      return if user.nil?
+      
+      person = configuration.convert_to_person(user).as_json
+      message_obj = Message.new(message).as_json
+
+      send_log(person, message_obj)
+    end
+    
+    protected
+
+    def send_log(person, event=nil)
+      psn = person.as_json
+      evt = event.nil? ? nil : event.as_json
+
+      if defined?(Preact::Sidekiq)
+        Preact::Sidekiq::PreactLoggingWorker.perform_async(psn, evt)
+      else
+        client.create_event(psn, evt)
+      end
+    end
+    
+    def client
+      self.default_client ||= Client.new
+    end
+  end
+end

data/readme.md

@@ -0,0 +1,111 @@
+Preact Logging API Ruby Client
+===
+Allow your Ruby app to easily submit server-side messages and events to Preact.
+
+Installation
+---
+
+In your Gemfile:
+
+```ruby
+gem 'preact'
+```
+
+Configuration
+---
+
+Configure Preact with your API credentials. You can find your Preact credentials on the [API settings page](https://secure.preact.io/settings/api) (This should go in an initializer file named `/config/initializers/preact.rb` in Rails applications)
+
+```ruby
+Preact.configure do |config|
+  config.code   = 'abcdefg'           # required
+  config.secret = '1234asdfasdf1234'  # required
+  
+  # Disable in Rails development environments
+  # config.disabled = (Rails.env != "development")
+  
+  # Uncomment this this line to customize the data sent with your Person objects.
+  # Your procedure should return a Hash of attributes
+  # config.person_builder = lambda {|user| {:keys => :values}}
+end
+```
+
+Usage
+---
+
+```ruby
+person = {
+  :name => "Christopher Gooley",
+  :email => "gooley@foliohd.com",
+  :uid => "gooley",
+  :properties => {
+    :account_level => "Pro",
+    :is_paying => true,
+    :created_at => 1347060566
+    :twitter => "gooley"
+  }
+}
+
+#common event examples:
+Preact.log_event(person, 'logged-in')
+Preact.log_event(person, 'upgraded')
+Preact.log_event(person, 'processed:payment', :revenue => 900) # revenue specified in cents
+Preact.log_event(person, "uploaded:file", :note => "awesome_resume.pdf")
+
+Preact.log_event(person, 'purchased:item', {
+    :note => "black shoes", 
+    :revenue => 2500, 
+    :extras => {
+      :size => "13",
+      :color => "blue"
+    })
+```
+
+ActiveRecord Integration
+---
+In your `User` model, you can define a `to_person` method returning a Hash. Preact will detect and use this method on users passed to its logging events.
+
+```ruby
+class User < ActiveRecord::Base
+  def to_person
+    {
+      :name => self.name,
+      :email => self.email,
+      :uid => self.id,
+      :properties => {
+        :account_level => self.account_level,
+        :is_paying => self.paying_customer?,
+        :created_at => self.created_at.to_i
+      }
+    }
+  end
+end
+```
+
+```ruby
+Preact.log_event(User.find(1), 'restored_answer_data') 
+Preact.log_event(User.find(1), 'updated-profile', :extras => {:twitter => "@gooley"})
+```
+
+Sidekiq Integration
+---
+Using [Sidekiq](http://sidekiq.org) for background processing? That's the best way to log data to Preact so it's not done in-process. 
+
+All you need to do is add `require 'preact/sidekiq'` at the top of your `preact.rb` initializer and we'll take it from there. Jobs will be placed on the :default queue.
+
+Devise / Warden Integration
+--
+Automatically log your login/logout events by including this in your `preact.rb` initializer. Just put it under the Preact config block.
+
+```ruby
+# after-auth hook to log the login
+Warden::Manager.after_authentication do |user,auth,opts|
+  Preact.log_event(user, "logged-in")
+end
+Warden::Manager.before_logout do |user,auth,opts|
+  Preact.log_event(user, "logged-out")
+end
+```
+
+
+Copyright (c) 2011-2013 Christopher Gooley, Preact. See LICENSE.txt for further details.

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: preact
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Christopher Gooley
+- Zach Millman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: API library to allow you to connect and submit messages and actions to
+  your Preact project account
+email: gooley@preact.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+files:
+- lib/preact/client.rb
+- lib/preact/configuration.rb
+- lib/preact/objects/action_event.rb
+- lib/preact/objects/api_object.rb
+- lib/preact/objects/event.rb
+- lib/preact/objects/message.rb
+- lib/preact/objects/person.rb
+- lib/preact/sidekiq/preact_logging_worker.rb
+- lib/preact/sidekiq.rb
+- lib/preact/version.rb
+- lib/preact.rb
+- readme.md
+- LICENSE.txt
+homepage: http://github.com/lessneglect/lessneglect-ruby
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Preact Logging API client library
+test_files: []