remetric 0.0.13 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f32b1eadb941c5b96a0f213218d60408347825e4
-  data.tar.gz: a564d61239c81596d531567b0c87a263ed7ff08a
+  metadata.gz: 126146869bea224d84523a2be545dc5b5c58a7f9
+  data.tar.gz: 931599e907e108a65798e346d1fa5644e5f4c2f0
 SHA512:
-  metadata.gz: 2a98e5b467fd03f1dcf2f261c5984974d2808a555b5010699560bf0f7a5ed97669100dcc684ee892040d899d27469639b96064cc1b08980bec9f4735e07710d8
-  data.tar.gz: fb36c300a78c94f2df3e974d21267beb91516542265e648c487b8410cd04a4f807cb7cbf1ee9e0d746a7f010cddb89bb73dc770122e1e9e77ae978856ad3299a
+  metadata.gz: 1c37dc322bf4b82d06232e5954ca003886766ab0003a4b57e17accbc72e54230bdab75b7dcde559b396d33e477908a8a5d56c51ae813ff529ec092493f688bb7
+  data.tar.gz: e6db2c780a24113edc5e1203b61e2a8e06609cd5311eb65bd6c616a61ed10811782b52ecef15df0884216d3381b740936bcd593ee734cf183964260d00b753cb

data/.gitignore

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

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in remetric.gemspec
 gemspec
-
-gem 'rest-client'

data/README.md

@@ -1,14 +1,16 @@
 # Remetric
 
-Remetric tracks your user data in a snap!
+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/remetric`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-This gem interacts with our API.
+TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'remetric'
+```ruby
+gem 'remetric'
+```
 
 And then execute:
 
@@ -20,30 +22,15 @@ Or install it yourself as:
 
 ## Usage
 
-`Key` is always required!
+TODO: Write usage instructions here
 
-```
-r = Remetric.new "#{remetric_api_token}"
-
-r.track "{{ name }} signed in with {{ email }}.", { 
-  key: user.id, 
-  email: user.email, 
-  name: user.name, 
-  last_sign_in: Time.now.to_i, 
-  comments: user.comments.count
-}
-
-r.save_contact({ 
-  key: user.id, 
-  email: user.email, 
-  name: user.name
-})
-```
+## 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
 
-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
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/remetric.
+

data/Rakefile

@@ -1 +1,11 @@
 require "bundler/gem_tasks"
+task :default => :spec
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/console

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

@@ -1,42 +1,9 @@
 require "remetric/version"
-require "base64"
-require "json"
-require "rest_client"
+require "remetric/client"
+require "remetric/http"
+require "remetric/endpoints/endpoint"
+require "remetric/endpoints/rest"
+require "remetric/endpoints/user"
 
-class Remetric
-  def initialize api_key, sandbox = false
-    @rm_api_key = api_key
-    @rm_sandbox = sandbox
-  end
-
-  def api_key
-    @rm_api_key
-  end
-
-  def track data = {}
-    begin
-      RestClient.get "#{endpoint}/track/img/#{to_base64 data}"
-    rescue
-      { errors: "You are unauthorized." }
-    end
-  end
-  
-  def img data = {}
-    src = "#{endpoint}/track/img/#{to_base64 data}"
-    img = "<img src=\"#{src}\" style=\"display: none; \">"
-    img
-  end
-  
-  def redirect data = {}
-    "#{endpoint}/track/redirect/#{to_base64 data}"
-  end
-  
-  def to_base64 data = {}
-    data["publishable_key"] = api_key
-    URI.escape Base64.encode64(JSON.generate(data))
-  end
-
-  def endpoint
-    @rm_sandbox ? "http://localhost:3000" : "https://secure.remetric.com"
-  end
+module Remetric
 end

data/lib/remetric/client.rb

@@ -0,0 +1,71 @@
+module Remetric
+  class Client
+    def initialize(opts = {})
+      @account = opts[:account]
+      @api_token = opts[:api_token]
+      @secret_key = opts[:secret_key]
+      @debug = opts[:debug]
+    end
+
+    def account
+      @account
+    end
+
+    def account=(account)
+      @account = account
+    end
+
+    def api_token
+      @api_token
+    end
+
+    def api_token=(api_token)
+      @api_token = api_token
+    end
+
+    def secret_key
+      @secret_key
+    end
+
+    def secret_key=(secret_key)
+      @secret_key = secret_key
+    end
+
+    def debug
+      @debug
+    end
+
+    def debug=(debug)
+      @debug = debug
+    end
+
+    def to_json
+      {
+        account: @account,
+        api_token: @api_token,
+        secret_key: @secret_key,
+        debug: @debug
+      }
+    end
+
+    def http
+      Remetric::HTTP.new self
+    end
+
+    def user
+      @user ||= Remetric::UserEndpoint.new self
+    end
+
+    def events
+      @events ||= Remetric::RESTEndpoint.new :events, self
+    end
+
+    def sequences
+      @events ||= Remetric::RESTEndpoint.new :events, self
+    end
+
+    def ctas
+      @ctas ||= Remetric::RESTEndpoint.new :ctas, self
+    end
+  end
+end

data/lib/remetric/endpoints/endpoint.rb

@@ -0,0 +1,19 @@
+module Remetric
+  class Endpoint
+    def initialize(client)
+      @client = client
+    end
+
+    def client
+      @client
+    end
+
+    def client=(client)
+      @client = client
+    end
+
+    def http
+      client.http
+    end
+  end
+end

data/lib/remetric/endpoints/rest.rb

@@ -0,0 +1,36 @@
+module Remetric
+  class RESTEndpoint < Remetric::Endpoint
+    def initialize(resource, client)
+      @resource = resource
+      @client = client
+    end
+
+    def resource
+      @resource
+    end
+
+    def resource=(resource)
+      @resource = resource
+    end
+
+    def list(args = {})
+      http.get "/#{client.account}/#{resource}", args
+    end
+
+    def show(id)
+      http.get "/#{client.account}/#{resource}/#{id}"
+    end
+
+    def create(args = {})
+      http.post "/#{client.account}/#{resource}", { event: args }
+    end
+
+    def update(id, args = {})
+      http.patch "/#{client.account}/#{resource}/#{id}", { event: args }
+    end
+
+    def destroy(id)
+      http.delete "/#{client.account}/#{resource}/#{id}"
+    end
+  end
+end

data/lib/remetric/endpoints/user.rb

@@ -0,0 +1,11 @@
+module Remetric
+  class UserEndpoint < Remetric::Endpoint
+    def identify(args = {})
+      if args.keys.length > 0
+        http.patch '/', { user: args }
+      else
+        http.get '/'
+      end
+    end
+  end
+end

data/lib/remetric/http.rb

@@ -0,0 +1,61 @@
+require 'rest-client'
+require 'base64'
+require 'json'
+
+module Remetric
+  class HTTP
+    def initialize(client)
+      @client = client
+    end
+
+    def client
+      @client
+    end
+
+    def root_url
+      # return "http://localhost:3000"
+      "https://api.remetric.com"
+    end
+
+    def rc
+      @rc ||= RestClient
+    end
+
+    def headers
+      {
+        Authorization: "Basic #{Base64.encode64("#{client.api_token}:#{client.secret_key}")}"
+      }
+    end
+
+    def opts
+      {
+        content_type: :json,
+        accept: :json
+      }
+    end
+
+    def parse(response)
+      JSON.parse response.body
+    end
+
+    def get(path, args = {})
+      response = rc.get "#{root_url}#{path}", headers.merge(params: args)
+      parse response
+    end
+
+    def post(path, args = {})
+      response = rc.post "#{root_url}#{path}", args, headers
+      parse response
+    end
+
+    def patch(path, args = {})
+      response = rc.patch "#{root_url}#{path}", args, headers
+      parse response
+    end
+
+    def delete(path)
+      response = rc.delete "#{root_url}#{path}", headers
+      parse response
+    end
+  end
+end

data/lib/remetric/version.rb

@@ -1,3 +1,3 @@
-class Remetric
-  VERSION = "0.0.13"
+module Remetric
+  VERSION = "1.0.0"
 end

data/remetric.gemspec

@@ -7,17 +7,20 @@ Gem::Specification.new do |spec|
   spec.name          = "remetric"
   spec.version       = Remetric::VERSION
   spec.authors       = ["Dallas Read"]
-  spec.email         = ["dallas@excitereative.ca"]
-  spec.description   = %q{Remetric tracks your user data in a snap!}
-  spec.summary       = %q{Remetric tracks your user data in a snap!}
+  spec.email         = ["dallas@excitecreative.ca"]
+
+  spec.summary       = %q{Interact with the Remetric API.}
+  spec.description   = %q{Interact with the Remetric API.}
   spec.homepage      = "http://www.remetric.com"
-  spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  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_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "rest-client", "~> 2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remetric
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 1.0.0
 platform: ruby
 authors:
 - Dallas Read
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2014-06-14 00:00:00.000000000 Z
+date: 2017-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,46 +16,65 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Remetric tracks your user data in a snap!
+        version: 2.0.0
+description: Interact with the Remetric API.
 email:
-- dallas@excitereative.ca
+- dallas@excitecreative.ca
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - lib/remetric.rb
+- lib/remetric/client.rb
+- lib/remetric/endpoints/endpoint.rb
+- lib/remetric/endpoints/rest.rb
+- lib/remetric/endpoints/user.rb
+- lib/remetric/http.rb
 - lib/remetric/version.rb
 - remetric.gemspec
 homepage: http://www.remetric.com
-licenses:
-- MIT
+licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -73,8 +92,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: Remetric tracks your user data in a snap!
+summary: Interact with the Remetric API.
 test_files: []

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 Dallas Read
-
-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.