simple_km 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brent Wheeldon
+
+MIT License
+
+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,30 @@
+# SimpleKM
+
+Very basic (thread-safe) client for the KissMetrics API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_km'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_km
+
+## Usage
+
+    $ client = SimpleKM::Client.new(api_key: <your API key>, user_identifier: <user identifer>)
+    $ client.record("action", some: "data")
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r simple_km.rb"
+end

data/lib/simple_km.rb

@@ -0,0 +1,7 @@
+require "httparty"
+require "addressable/uri"
+require "simple_km/version"
+require "simple_km/client"
+
+module SimpleKM
+end

data/lib/simple_km/client.rb

@@ -0,0 +1,30 @@
+class SimpleKM::Client
+  DEFAULT_URI_PARAMS = {
+    scheme: "https",
+    host: "trk.kissmetrics.com",
+    path: "e"
+  }
+
+  attr_reader :api_key, :user_identifier
+
+  def initialize options
+    @api_key = options[:api_key]
+    @user_identifier = options[:user_identifier]
+
+    raise ArgumentError unless api_key && user_identifier
+  end
+
+  def record action, data
+    data ||= {}
+    raise ArgumentError unless data.is_a?(Hash)
+
+    query_values = {
+      _k: api_key,
+      _p: user_identifier,
+      _n: action,
+    }.merge(data)
+    uri = Addressable::URI.new(DEFAULT_URI_PARAMS.merge(query_values: query_values))
+
+    HTTParty.get(uri.to_s)
+  end
+end

data/lib/simple_km/version.rb

@@ -0,0 +1,3 @@
+module SimpleKM
+  VERSION = "0.0.2"
+end

data/simple_km.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_km/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "simple_km"
+  gem.version       = SimpleKM::VERSION
+  gem.authors       = ["Brent Wheeldon"]
+  gem.email         = ["brent.wheeldon@gmail.com"]
+  gem.description   = %q{Threadsafe KissMetrics client}
+  gem.summary       = %q{Very basic client for the KissMetrics API}
+  gem.homepage      = "https://github.com/BrentWheeldon/simple_km"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'httparty'
+  gem.add_dependency 'addressable'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pry'
+end

data/spec/simple_km/client_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe SimpleKM::Client do
+  describe "#initialize" do
+    context "when the API key is nil" do
+      it "should raise an ArgumentError" do
+        expect { SimpleKM::Client.new(user_identifier: "foo") }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "when the user identifier is nil" do
+      it "should raise an ArgumentError" do
+        expect { SimpleKM::Client.new(api_key: "foo") }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "when both the API key and the user identifier are specified" do
+      it "should not raise an error" do
+        expect { SimpleKM::Client.new(api_key: "foo", user_identifier: "bar") }.not_to raise_error
+      end
+    end
+  end
+
+  describe "#record" do
+    let(:api_key) { "somekey" }
+    let(:user_identifier) { "foo@bar.com" }
+    let(:action) { "some action" }
+    let(:client) { SimpleKM::Client.new(api_key: api_key, user_identifier: user_identifier) }
+
+    context "when data is not nil" do
+      context "when the data is a hash" do
+        let(:data) { { some: "data" } }
+
+        it "should set a get request to the correctly formatted url" do
+          HTTParty.should_receive(:get).with("https://trk.kissmetrics.com/e?_k=somekey&_n=some%20action&_p=foo%40bar.com&some=data")
+
+          client.record(action, data)
+        end
+      end
+
+      context "when the data is not a hash" do
+        let(:data) { "foo" }
+
+        it "should raise an ArgumentError" do
+          expect{ client.record(action, data) }.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+    context "when data is nil" do
+      let(:data) { nil }
+
+      it "should set a get request to the correctly formatted url" do
+        HTTParty.should_receive(:get).with("https://trk.kissmetrics.com/e?_k=somekey&_n=some%20action&_p=foo%40bar.com")
+
+        client.record(action, data)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'pry'
+require 'simple_km'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: simple_km
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Brent Wheeldon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: addressable
+  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: '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: pry
+  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'
+description: Threadsafe KissMetrics client
+email:
+- brent.wheeldon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_km.rb
+- lib/simple_km/client.rb
+- lib/simple_km/version.rb
+- simple_km.gemspec
+- spec/simple_km/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/BrentWheeldon/simple_km
+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.24
+signing_key: 
+specification_version: 3
+summary: Very basic client for the KissMetrics API
+test_files:
+- spec/simple_km/client_spec.rb
+- spec/spec_helper.rb