framed_rails 0.1.0

data/.gitignore

@@ -0,0 +1,11 @@
+Gemfile.lock
+.DS\_Store
+.svn/
+*~
+*.rbc
+pkg/
+*.gem
+!rails
+Manifest*
+gems/framed_rails.gemspec
+gems/framed_rails*.tar.gz

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p551@framed_rails

data/CHANGELOG

@@ -0,0 +1 @@
+CHANGELOG

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1 @@
+LICENSE

data/README.md

@@ -0,0 +1,107 @@
+`framed_rails`
+------------
+
+`framed_rails` is a gem to add Framed instrumentation to your rails4
+app.  For each pageview, it sends an event to Framed.
+
+To use this with rails:
+
+
+ * Add `framed_rails` to your Gemfile.
+ * Add the following to `config/initializers/framed_rails.rb`:
+
+```ruby
+require 'framed_rails'
+
+Framed.configure do |config|
+  config[:write_key] = 'Framed key'
+end
+```
+
+Note that the threaded emitter works on a background thread.  It is
+possible that events will be unreported when your containing process
+ends, unless you drain at process shutdown, i.e.
+
+```ruby
+Framed.drain
+```
+
+If reporting fails, the exception will be logged to STDERR by default,
+unless Rails is detected.  In that case, the `Rails.logger` will be
+used.
+
+
+Configuration
+-------------
+
+<table>
+	<tr>
+    <th>Key</th>
+    <th>Description</th>
+    <th>Default</th>
+  </tr>
+
+  <tr>
+    <td>:consumer</td>
+    <td>The emitter to be used for reporting.  See the Emitters
+    section below.</td>
+    <td>Framed::Emitters::Blocking</td>
+  </tr>
+
+	<tr>
+    <td>:endpoint</td>
+    <td>The URL to POST to, using basic auth with your write key</td>
+    <td>Framed::SEGMENT_API</td>
+  </tr>
+
+  <tr>
+    <td>:user_id_controller_method</td>
+    <td>The name of a controller method which returns the user ID, if
+    any</td>
+    <td>'framed_devise_user_id'</td>
+  </tr>
+
+	<tr>
+    <td>:logger</td>
+    <td>A Logger for reporting errors.</td>
+    <td>STDERR, or Rails.logger if detected.</td>
+  </tr>
+
+	<tr>
+    <td>:anonymous_cookie</td>
+    <td>The name of the in signed cookie for anonymous user IDs.
+    Long-lived anonymous user IDs are issued anonymous users.</td>
+    <td>Framed::COOKIE_NAME</td>
+  </tr>
+
+	<tr>
+    <td>:user_id_controller_method</td>
+    <td>The name of a controller method which can provide the current
+    User ID.  Devise just works.</td>
+    <td>'framed_devise_user_id'</td>
+  </tr>
+</table>
+
+Emitters
+--------
+
+By default, the report is sent with a blocking Emitter.  If you would
+prefer a non-blocking emitter, you can include the following line in
+your configure block:
+
+
+```ruby
+  config[:consumer] => Framed::Emitters::Threaded
+```
+
+If you'd like to implement your own, see `lib/framed/emitters.rb`,
+particularly Base and Blocking as examples.
+
+Emitters included in this gem:
+
+ * `Framed::Emitters::InMemory` - stores reported events in memory,
+   rather than transmitting them.   Events are later available as
+   Framed.consumer.reported.
+ * `Framed::Emitters::Logger` - Logs an info message to config[:logger].
+ * `Framed::Emitters::Blocking` - Logs to Framed, using a blocking request.
+ * `Framed::Emitters::Threaded` - Logs to Framed, using a background-threaded request.

data/framed_rails.gemspec

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'framed/version'
+
+Gem::Specification.new do |s|
+  s.name = "framed_rails"
+  s.version = Framed::VERSION
+  s.required_ruby_version = '>= 1.8.7'
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = [ "Jeremy Dunck" ]
+  s.date = Time.now.strftime('%Y-%m-%d')
+  s.licenses    = ['MIT']
+  s.description = <<-EOS
+TK
+EOS
+  s.email = "support@framed.io"
+  s.executables = [ ]
+  s.extra_rdoc_files = [
+    "CHANGELOG",
+    "LICENSE",
+    "README.md"
+  ]
+
+  file_list = `git ls-files`.split
+  s.files = file_list
+
+  s.homepage = "http://www.github.com/framed-data/framed_rails"
+  s.require_paths = ["lib", 'vendor/gems/excon-0.45.3/lib']
+  s.rubygems_version = Gem::VERSION
+  s.summary = "Framed.io data collector"
+
+  # s.add_development_dependency 'rake', '10.1.0'
+
+  # FIXME: RUBY_VERSION, RUBY_PLATFORM, RUBY_ENGINE
+end

data/lib/framed/client.rb

@@ -0,0 +1,34 @@
+require 'excon'
+require 'base64'
+require 'json'
+
+require 'framed/exceptions'
+
+module Framed
+  class Client
+    attr_accessor :config
+
+    def initialize(config)
+      raise Error.new('No API endpoint specified') unless config[:endpoint]
+      raise Error.new('No write_key specified') unless config[:write_key]
+
+      @config = config
+    end
+
+    def track(data)
+      write_key = Base64.strict_encode64(@config[:write_key])
+      payload = JSON.generate(data)
+      response = Excon.post(@config[:endpoint],
+        :headers => {
+          'Authorization' => "Basic #{write_key}",
+          'Content-Type' => 'application/json'
+        },
+        :body => payload
+      )
+
+      if response.status != 200
+        raise Framed::RequestError.new("Failed Client.track #{response.status} with data #{payload}")
+      end
+    end
+  end
+end

data/lib/framed/emitters.rb

@@ -0,0 +1,113 @@
+require 'thread'
+require 'json'
+
+module Framed
+  module Emitters
+    class Base
+      def initialize(client)
+        @client = client
+      end
+
+      def stop(drain = false)
+
+      end
+      def start
+
+      end
+
+      def enqueue(event)
+        raise NotImplementedError
+      end
+
+      private
+
+      def transmit(event)
+        begin
+          @client.track(event)
+        rescue StandardError => exc
+          Framed.logger.error("framed_rails: transmit failed: #{exc}")
+        end
+      end
+    end
+
+    class InMemory < Base
+      attr_reader :reported
+
+      def initialize(client)
+        super
+        @reported = []
+      end
+
+      def enqueue(event)
+        @reported << event
+      end
+    end
+
+    class Logger < Base
+      def enqueue(event)
+        Framed.logger.info(JSON.generate(event))
+      end
+    end
+
+    class Threaded < Base
+      def initialize(client)
+        super
+        @queue = Queue.new
+      end
+
+      def enqueue(event)
+        @queue << event
+        start
+      end
+
+      def start
+        return if @thread
+
+        @thread = Thread.new do
+          while true
+            begin
+              process_events
+            rescue StandardError => exc
+              Framed.logger.error("framed_rails: run_thread failed: #{exc}")
+              stop
+            end
+            sleep(0.5)
+          end
+        end
+      end
+
+      def stop(drain = false)
+        if @thread
+          @thread.kill
+        end
+        @thread = nil
+
+        if drain && @queue.length
+          process_events
+        end
+      end
+
+      private
+
+      def dequeue
+        @queue.pop
+      end
+
+      def process_events
+        while @queue.length > 0
+          transmit(dequeue)
+        end
+      end
+    end
+
+    class Blocking < Base
+      def start
+      end
+      def stop
+      end
+      def enqueue(event)
+        transmit(event)
+      end
+    end
+  end
+end

data/lib/framed/example.rb

@@ -0,0 +1,17 @@
+require 'framed_rails'
+
+Framed.configure do |config|
+  config[:write_key] = 'XWkzILLq5gLUKXQUhAl4DJej1wkxqiBy'
+#  config[:consumer] = Framed::Blocking
+end
+
+data = { 
+  anonymousId: "anon1",
+  userId: "user1",
+  event: "signup",
+  properties: {
+    name: "value"
+  }
+}
+
+Framed.report(data) 

data/lib/framed/exceptions.rb

@@ -0,0 +1,13 @@
+module Framed
+  class Error < ::StandardError
+  end
+
+  class RequiredConfiguration < Error
+  end
+
+  class Timeout < Error
+  end
+
+  class RequestError < Error
+  end
+end