orwell-mole 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25f0049bf2485cbd493191b024fe25d40892e338
+  data.tar.gz: 6fd44b51ea7258f51a13f9150d29d9b649803398
+SHA512:
+  metadata.gz: 861cd019f9b8b09688b82a55b873ae1aed232f9e77a4357d7977ad430ffdf6610a27446d818870a98617ea8ce98691df73501b2e23212e854ba096e37f5a3c31
+  data.tar.gz: 2ed88dd3a601855dfcf2a646dac56a132bb5e876e60f0f4da5797374701709d80815a90a5aab20000592913ab83abbc7692acdf70d074dc3eefc0bbb589adf47

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Sean
+
+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,27 @@
+# Mole
+
+Easily send events to Orwell from within your Ruby application.
+
+[![Gem Version](https://badge.fury.io/rb/orwell-mole.png)](https://rubygems.org/gems/orwell-mole)[![Build Status](https://travis-ci.org/doomspork/mole.svg?branch=master)](https://travis-ci.org/doomspork/mole) [![Code Climate](https://codeclimate.com/github/doomspork/mole/badges/gpa.svg)](https://codeclimate.com/github/doomspork/mole) [![Coverage Status](https://coveralls.io/repos/doomspork/mole/badge.png)](https://coveralls.io/r/doomspork/mole) [![Dependency Status](https://gemnasium.com/doomspork/mole.svg)](https://gemnasium.com/doomspork/mole)
+
+### Gemfile
+
++ `gem 'orwell-mole', require: 'orwell/mole'`
+
+### Configuration
+
+```ruby
+Mole.config do |c|
+  c.api_token = 'your orwell api token'
+end
+```
+
+### Usage
+
+```ruby
+@channel = Mole.channel(:accounts)
+@channel.record(:new_account, params[:email], params)
+
+@channel = Mole.track(@user.email, :accounts)
+@channel.record(:password_change)
+```

data/lib/orwell/mole/client.rb

@@ -0,0 +1,33 @@
+module Mole
+  class Client
+
+    attr_reader :channel, :identifier, :transporter
+
+    def initialize(channel, transporter)
+      @channel     = channel
+      @transporter = transporter
+    end
+
+    def identify(id)
+      @identifier = id
+    end
+
+    def record(event, *args)
+      identifier, details = expand_args(args)
+      event = Event.new(channel, event, identifier, details)
+      @transporter.perform(event)
+    end
+
+    private
+
+    def expand_args(args)
+      id, details = args
+      if id.is_a?(Hash)
+        details = id
+        id      = nil
+      end
+      id = @identifier unless id
+      [id, details]
+    end
+  end
+end

data/lib/orwell/mole/config.rb

@@ -0,0 +1,52 @@
+require 'orwell/mole/errors/missing_api_token_error'
+
+module Mole
+  class Config
+    DEFAULT_HOST = 'api.orwell.io'
+    DEFAULT_POST = 80
+    DEFAULT_API_VERSION = '0.1.0'
+
+    attr_accessor :api_token
+    attr_writer  :api_version, :host, :logger, :method, :port
+
+    def api_token
+      raise MissingApiTokenError unless @api_token
+      @api_token
+    end
+
+    def api_version
+      @api_version || DEFAULT_API_VERSION
+    end
+
+    def host
+      @host || DEFAULT_HOST
+    end
+
+    def log
+      @logger || default_logger
+    end
+
+    def method
+      @method || :basic_http
+    end
+
+    def port
+      @port || DEFAULT_POST
+    end
+
+    def reset!
+      @api_token, @api_version, @host, @logger, @method, @port = nil
+    end
+
+    private
+
+    def default_logger
+      unless @default_logger
+        require 'logger'
+        @default_logger = Logger.new(STDOUT)
+      end
+      @default_logger
+    end
+
+  end
+end

data/lib/orwell/mole/errors/missing_api_token_error.rb

@@ -0,0 +1,7 @@
+module Mole
+  class MissingApiTokenError < StandardError
+    def initialize(msg = "Missing required API token.")
+      super
+    end
+  end
+end

data/lib/orwell/mole/event.rb

@@ -0,0 +1,21 @@
+module Mole
+  class Event
+    attr_accessor :channel, :event, :identifier, :details
+
+    def initialize(channel, event, identifier, details = {})
+      @channel    = channel
+      @event      = event
+      @identifier = identifier
+      @details    = details
+    end
+
+    def to_h
+      {
+        channel:     channel,
+        event:       event,
+        identifier:  identifier,
+        details:     details
+      }
+    end
+  end
+end

data/lib/orwell/mole/transport/basic_http.rb

@@ -0,0 +1,47 @@
+require 'json'
+require 'net/http'
+
+module Mole
+  module Transport
+    class BasicHttp
+      attr_reader :host, :port, :token, :version
+
+      def initialize(opts = {})
+        @host    = opts[:host]
+        @port    = opts[:port]
+        @token   = opts[:api_token]
+        @version = opts[:api_version]
+      end
+
+      def perform(event)
+        json     = event_json(event)
+        response = post(json)
+        success(response)
+      end
+
+      private
+
+      def success(resp)
+        resp.is_a? Net::HTTPSuccess
+      end
+
+      def post(params)
+        Net::HTTP.start(host, port) do |http|
+          http.post('/events', params, headers)
+        end
+      end
+
+      def event_json(event)
+        JSON.generate(event.to_h)
+      end
+
+      def headers
+        {
+          'accept'       => "application/vnd.orwell.api.json; version=#{version}",
+          'orwell_token' => token
+        }
+      end
+
+    end
+  end
+end

data/lib/orwell/mole/transporter.rb

@@ -0,0 +1,37 @@
+require 'orwell/mole/transport/basic_http'
+
+module Mole
+  class Transporter
+    extend Forwardable
+
+    def_delegators :transport, :perform
+
+    attr_reader :transport
+
+    def initialize(transport)
+      @transport = lookup(transport)
+    end
+
+    private
+
+    def lookup(transport)
+      case transport
+      when :basic_http
+        Transport::BasicHttp.new(config_hash)
+      when :sidekiq
+        raise NotImplementedError
+      else nil
+      end
+    end
+
+    def config_hash
+      {
+        api_token:    Mole.config.api_token,
+        api_version:  Mole.config.api_version,
+        host:         Mole.config.host,
+        port:         Mole.config.port
+      }
+    end
+
+  end
+end

data/lib/orwell/mole/version.rb

@@ -0,0 +1,3 @@
+module Mole
+  VERSION = '0.1.0'
+end

data/lib/orwell/mole.rb

@@ -0,0 +1,33 @@
+require 'orwell/mole/version'
+require 'orwell/mole/config'
+require 'orwell/mole/event'
+require 'orwell/mole/transporter'
+require 'orwell/mole/client'
+
+module Mole
+  def self.config
+    @config ||= Config.new
+    yield @config if block_given?
+    @config
+  end
+
+  def self.channel(name)
+    new_client(name)
+  end
+
+  def self.track(identifier, name)
+    client = new_client(name)
+    client.identify(identifier)
+    client
+  end
+
+  private
+
+  def self.new_client(channel)
+    Client.new(channel, self.transporter)
+  end
+
+  def self.transporter
+    @transporter ||= Transporter.new(config.method)
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: orwell-mole
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Callan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+description: Mole allows developers to send events from within their code directly
+  to Orwell.
+email:
+- seancallan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/orwell/mole/client.rb
+- lib/orwell/mole/config.rb
+- lib/orwell/mole/errors/missing_api_token_error.rb
+- lib/orwell/mole/event.rb
+- lib/orwell/mole/transport/basic_http.rb
+- lib/orwell/mole/transporter.rb
+- lib/orwell/mole/version.rb
+- lib/orwell/mole.rb
+homepage: http://www.orwell.io
+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.0.14
+signing_key: 
+specification_version: 4
+summary: A client library for Orwell
+test_files: []
+has_rdoc: