taroko-drucker 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2891f4b095d421bfb7ad1507de341aa591e31af3
+  data.tar.gz: dcb64923143649108fe39c24a859987f213f1c65
+SHA512:
+  metadata.gz: 8f3981ac3715105a63718941845796c3f56c3579d994be2ec3909fc4957f5284220a262d2a5f090b47f3053e2534db732d30cde128418d94bab42a110880805a
+  data.tar.gz: e0989c698c51c15eae867120f2f1b32762c6241610cc258bd71910ea0fb13730ccec269ca496e9f4611ef6cea3fda98be11446b53748edee1b4bcc711d10a380

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in taroko-drucker.gemspec
+gemspec

data/README.md

@@ -0,0 +1,72 @@
+# Taroko::Drucker
+
+Ruby client for Drucker event tracking system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'taroko-drucker'
+```
+
+And then execute:
+
+    $ bundle
+
+## Setup
+
+Setup your application unique ID into Drucker:
+
+```ruby
+# config/initializers/drucker.rb
+Taroko::Drucker.setup do |config|
+  config.project_id = 'YOUR_PROJECT_ID' # must be a UUID
+end
+```
+
+## Usage
+
+To send an event to Drucker:
+```ruby
+Taroko::Drucker::Event.create(event_type: 'purchase', count: 1)
+# returns `true` if event sent to Drucker successfully, otherwise `false`.
+
+# or
+
+event = Taroko::Drucker.new
+event.create(event_type: 'purchase', count: 1)
+# returns `true` if event sent to Drucker successfully, otherwise `false`.
+```
+
+`Taroko::Drucker::Event.create` accepts following parameters:
+
+| Name            | Required | Data type     | Description                    | Example                                                 |
+|-----------------|----------|---------------|--------------------------------|---------------------------------------------------------|
+| event_type      | yes      | string/symbol | Event type                     | `:renewal`, `'renewal'`, `:purchase`, `'purchase'`, etc |
+| count           | yes      | integer       | Event happens times            | 1, 2, etc                                               |
+| user_id         | no       | UUID          | Unique ID of the user          | e1cc5111-33db-491c-9e73-fca4953bec34                    |
+| user_attributes | no       | hash          | Data which describes the user  | `{ first_name: 'Jon', last_name: 'Snow' }`              |
+| attributes      | no       | hash          | Data which describes the event | `{ session_id: 'adsfsadf' }`              |
+
+Notice that if you send incorrect type of params, it'll raise `ArgumentError` with messages.
+
+## Debug mode
+
+Sometimes you want to know the response from Drucker:
+```ruby
+event_agent = Taroko::Drucker::Event.new
+event_agent.create(params) # returns `false` if event is not record by Drucker correctly.
+event_agent.error #=> { status: 400, body: 'error message from Drucker server' }
+```
+
+## Development
+
+Run all tests:
+```
+bundle exec rake
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/resumecompanion/drucker-client-ruby.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "taroko/drucker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/taroko/drucker.rb

@@ -0,0 +1,15 @@
+require "taroko/drucker/version"
+
+module Taroko
+  module Drucker
+    require 'taroko/drucker/event'
+
+    class << self
+      attr_accessor :project_id
+
+      def setup
+        yield self
+      end
+    end
+  end
+end

data/lib/taroko/drucker/event.rb

@@ -0,0 +1,79 @@
+require 'faraday'
+
+module Taroko
+  module Drucker
+    class Event
+      REQUIRED_PARAMS = %w(
+        event_type
+        count
+      )
+
+      attr_reader :error
+
+      def self.create(params)
+        new.create(params)
+      end
+
+      def create(params)
+        stringify_keys_for(params)
+        add_info
+        validate
+        send_request
+      end
+
+      private
+
+      attr_reader :params
+
+      def stringify_keys_for(params)
+        @params = params.inject({}) { |memo, (k,v)| memo[k.to_s] = v; memo } # stringify_key
+      end
+
+      def validate
+        missing_keys = REQUIRED_PARAMS - params.keys
+        v4_uuid_regex = /[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}/
+
+        raise ArgumentError, "Missing params: #{missing_keys.join(', ')}" unless missing_keys.empty?
+        raise ArgumentError, '`project_id` is not a valid UUID, please setup correctly in `config/initializers/drucker.rb`' unless params['project_id'] =~ v4_uuid_regex
+        raise ArgumentError, '`event_type` must be a string or symbol' unless (params['event_type'].is_a?(String) || params['event_type'].is_a?(Symbol))
+        raise ArgumentError, '`event_type` cannot be blank' if params['event_type'].length.zero?
+        raise ArgumentError, '`count` must be an integer' unless params['count'].is_a? Integer
+        raise ArgumentError, '`count` must greater than 0' unless params['count'] > 0
+        raise ArgumentError, '`user_id` is not a valid UUID' if params['user_id'] && params['user_id'] !~ v4_uuid_regex
+        raise ArgumentError, '`user_attributes` must be a hash' if params['user_attributes'] && !params['user_attributes'].is_a?(Hash)
+        raise ArgumentError, '`attributes` must be a hash' if params['attributes'] && !params['attributes'].is_a?(Hash)
+      end
+
+      def add_info
+        params['project_id'] = Taroko::Drucker.project_id
+        params['happen_at'] = defined?(Rails) ? Time.current.to_i : Time.now.to_i
+      end
+
+      def send_request
+        response = Faraday.post(url, params)
+
+        case response.status
+        when 200, 201 then true
+        else
+          @error = { status: response.status, body: response.body }
+          false
+        end
+      end
+
+      def url
+        if production?
+          # TODO: replace to production url
+          raise NotImplementedMethod, 'please put a production url here'
+        else
+          'http://localhost:3000/api/v1/events'
+        end
+      end
+
+      def production?
+        return true if defined?(Rails) && Rails.env.production?
+        return true if ENV['RACK_ENV'] == 'production'
+        false
+      end
+    end
+  end
+end

data/lib/taroko/drucker/version.rb

@@ -0,0 +1,5 @@
+module Taroko
+  module Drucker
+    VERSION = "0.1.2"
+  end
+end

data/taroko-drucker.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "taroko/drucker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "taroko-drucker"
+  spec.version       = Taroko::Drucker::VERSION
+  spec.authors       = ["Tarokosoftware"]
+  spec.email         = ["taroko@tarokosoftware.com"]
+
+  spec.summary       = %q{Drucker client for Ruby.}
+  spec.description   = %q{Send event in Rails application to Drucker.}
+  spec.homepage      = "http://tarokosoftware.com"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "faraday", "~> 0.12"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: taroko-drucker
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Tarokosoftware
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Send event in Rails application to Drucker.
+email:
+- taroko@tarokosoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/taroko/drucker.rb
+- lib/taroko/drucker/event.rb
+- lib/taroko/drucker/version.rb
+- taroko-drucker.gemspec
+homepage: http://tarokosoftware.com
+licenses: []
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Drucker client for Ruby.
+test_files: []
+has_rdoc: