kilometer-ruby 0.1.1 → 0.1.2

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.iml
+.idea
+.idea/*
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kilometer-ruby-api-ruby-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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,41 @@
+# Events::Api::Ruby::Client
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/events/api/ruby/client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'events-api-ruby-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install events-api-ruby-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/events-api-ruby-client.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/README.rst

@@ -0,0 +1 @@
+Events API client for Ruby

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kilometer-ruby"
+
+# 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

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/kilometer-ruby.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kilometer-ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kilometer-ruby"
+  spec.version       = Kilometer::VERSION
+  spec.authors       = ["Yuri Kroz"]
+  spec.email         = ["yuri@kilometer.io"]
+  spec.summary       = "The official Kilometer.io Ruby library."
+  spec.description   = "This is the official Kilometer.io Ruby library. This library allows for server-side integration of Kilometer."
+  spec.homepage      = "http://kilometer.io"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.12.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/kilometer-ruby/version.rb

@@ -0,0 +1,3 @@
+module Kilometer
+  VERSION = '0.1.2'
+end

data/lib/kilometer-ruby.rb

@@ -0,0 +1,182 @@
+require_relative 'kilometer-ruby/version'
+require 'date'
+require 'net/http'
+require 'json'
+require 'uri'
+
+module Kilometer
+
+  class EventsAPIClient
+    # Use Kilometer::EventsAPIClient to track events and manage users properties.
+
+    HEADER_CUSTOMER_APP_ID = 'Customer-App-Id'
+    HEADER_TIMESTAMP = 'Timestamp'
+    HEADER_CLIENT_TYPE = 'Client-Type'
+    HEADER_CONTENT_TYPE = 'Content-Type'
+    CLIENT_TYPE = 'ruby'
+    CONTENT_TYPE = 'application/json'
+
+    def initialize(token, endpoint_url=nil)
+      @token = token
+      @endpoint_url = endpoint_url || 'http://events.kilometer.io'
+    end
+
+    public
+
+    # Creates a new identified user if he doesn't exist.
+    #
+    #     user_id: identified user's ID
+    #     headers: custom request headers (if isn't set default values are used)
+    #     endpoint_url: where to send the request (if isn't set default value is used)
+    def add_user(user_id, headers=nil, endpoint_url=nil)
+
+      uri = URI("#{endpoint_url || @endpoint_url}/users")
+
+      Net::HTTP.start(uri.host, uri.port) do |http|
+
+        request = Net::HTTP::Post.new(uri.request_uri)
+
+        # Set headers
+        if headers
+          headers.each { |header, value| request.add_field(header, value) }
+        else
+          self.set_default_headers(request)
+          request.add_field(HEADER_CONTENT_TYPE, CONTENT_TYPE)
+        end
+
+        # Set payload
+        request.body = {user_id: user_id}.to_json
+
+        # Execute the request
+        http.request(request)
+      end
+    end
+
+    # Send an identified event. If a user doesn't exist it will create one.
+    #
+    #    user_id: identified user's ID
+    #    event_name: event name (e.g. "visit_website")
+    #    event_properties: properties that describe the event's details
+    #    headers: custom request headers (if isn't set default values are used)
+    #    endpoint_url: where to send the request (if isn't set default value is used)
+    def add_event(user_id, event_name, event_properties=nil, headers=nil, endpoint_url=nil)
+
+      uri = URI("#{endpoint_url || @endpoint_url}/events")
+
+      Net::HTTP.start(uri.host, uri.port) do |http|
+
+        request = Net::HTTP::Post.new(uri.request_uri)
+
+        # Set headers
+        if headers
+          headers.each { |header, value| request.add_field(header, value) }
+        else
+          self.set_default_headers(request)
+          request.add_field(HEADER_CONTENT_TYPE, CONTENT_TYPE)
+        end
+
+        # Set payload
+        request.body = {
+            user_id: user_id,
+            event_name: event_name,
+            event_type: 'identified',
+            event_properties: event_properties || {}
+        }.to_json
+
+        # Execute the request
+        http.request(request)
+      end
+    end
+
+    # Increase a user's property by a value.
+    #
+    #    user_id: identified user's ID
+    #    property_name: user property name to increase
+    #    value: amount by which to increase the property
+    #    headers: custom request headers (if isn't set default values are used)
+    #    endpoint_url: where to send the request (if isn't set default value is used)
+    def increase_user_property(user_id, property_name, value=0, headers=nil, endpoint_url=nil)
+      inc_or_dec_user_property('increase', user_id, property_name, value, headers, endpoint_url)
+    end
+
+    # Decrease a user's property by a value.
+    #
+    #    user_id: identified user's ID
+    #    property_name: user property name to decrease
+    #    value: amount by which to decrease the property
+    #    headers: custom request headers (if isn't set default values are used)
+    #    endpoint_url: where to send the request (if isn't set default value is used)
+    def decrease_user_property(user_id, property_name, value=0, headers=nil, endpoint_url=nil)
+      inc_or_dec_user_property('decrease', user_id, property_name, value, headers, endpoint_url)
+    end
+
+    # Update a user's properties with values provided in "user_properties" dictionary
+    #
+    #   user_id: identified user's ID
+    #   user_properties: user properties to update with a new values
+    #   headers: custom request headers (if isn't set default values are used)
+    #   endpoint_url: where to send the request (if isn't set default value is used)
+    def update_user_properties(user_id, user_properties, headers=nil, endpoint_url=nil)
+
+      uri = URI("#{endpoint_url || @endpoint_url}/users/#{user_id}/properties")
+
+      Net::HTTP.start(uri.host, uri.port) do |http|
+
+        request = Net::HTTP::Put.new(uri.request_uri)
+
+        # Set headers
+        if headers
+          headers.each { |header, value| request.add_field(header, value) }
+        else
+          self.set_default_headers(request)
+          request.add_field(HEADER_CONTENT_TYPE, CONTENT_TYPE)
+        end
+
+        # Set payload
+        request.body = user_properties.to_json
+
+        # Execute the request
+        http.request(request)
+      end
+
+
+    end
+
+    # Gets Net::HTTP request instance and modifies it by adding default HTTP headers.
+    #
+    # WARNING: The method modifies the #request object!
+    def set_default_headers(request)
+      request.add_field(HEADER_CUSTOMER_APP_ID, @token)
+      request.add_field(HEADER_CLIENT_TYPE, CLIENT_TYPE)
+      request.add_field(HEADER_TIMESTAMP, Kilometer::now)
+    end
+
+    private
+
+    def inc_or_dec_user_property(action, user_id, property_name, value=0, headers=nil, endpoint_url=nil)
+
+      uri = URI("#{endpoint_url || @endpoint_url}/users/#{user_id}/properties/#{property_name}/#{action}/#{value}")
+
+      Net::HTTP.start(uri.host, uri.port) do |http|
+
+        request = Net::HTTP::Post.new(uri.request_uri)
+
+        # Set headers
+        if headers
+          headers.each { |header, value_| request.add_field(header, value_) }
+        else
+          self.set_default_headers(request)
+        end
+
+        # Execute the request
+        http.request(request)
+      end
+    end
+
+  end
+
+  # Get current timestamp in milliseconds
+  def self.now
+    DateTime.now.strftime('%Q')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kilometer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -50,7 +50,18 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- README.rst
+- Rakefile
+- bin/console
+- bin/setup
+- kilometer-ruby.gemspec
+- lib/kilometer-ruby.rb
+- lib/kilometer-ruby/version.rb
 homepage: http://kilometer.io
 licenses:
 - MIT
@@ -63,7 +74,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: