hyperfocal 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc9860648d47875518439d878fee9c6413df7666
-  data.tar.gz: d5d4479d9d5a7ea19bfec3553d12de7596658427
+  metadata.gz: 6c47d9b331310563355dcb8b4bb2c1b7aa2e9534
+  data.tar.gz: e576d76d0078155f23cdb3b803df78a4f8dba3ab
 SHA512:
-  metadata.gz: 3b6addbcd704ae91679a7bd1a126ff10bfaa08dd1a05b6c8c7bb33b0a9ca4a8c20ae4beaf8937d70e3abf7b9ba79eb7eb2a50ceab8578443025364bf62ee2d43
-  data.tar.gz: 73638686a4a29194b4aa4611b7999c083c74e5385c2e51749671478b3b6c1a0b137367f7dcb29bc902a8a56ba30dcd2cefac8dffb4fb03fa640a40fa0b7b7f8b
+  metadata.gz: 61f9f5ad2fee2b3cccd81f3a9f9e0919b4a3825e4d5ce4a8b930544a8bd3f558bbe1823190ede5a9337178173dfcfbea1f668bda99042207fe6d17eab413ce41
+  data.tar.gz: 5af1ccb7e298781fce47c09349f7eb6783f9b991b23cceacb294417ff4523086bddd7cba6d0bac7eb86fb91c1cd3c405c3534ef10df9d1640c0749744f795897

data/README.md

@@ -1,39 +1,52 @@
 # Hyperfocal
 
-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/hyperfocal`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Installation
 
-TODO: Delete this and the text above, and describe your gem
+Visit [hyperfocal.io](http://hyperfocal.io) to set up an account, and find installation instructions
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+After making sure you have an account on Hyperfocal, you can use the following
+ in your application.
 
-```ruby
-gem 'hyperfocal'
-```
+### Event Tracking
 
-And then execute:
+To track an event, simply use this line in your application
+ `Hyperfocal.event('event_name', other_attributes_as_hash)`
 
-    $ bundle
+Optional (but helpful) attributes to include
 
-Or install it yourself as:
+```
+user_id: Used to filter events by user/unique user
+```
 
-    $ gem install hyperfocal
+This will send an event to Hyperfocal
 
-## Usage
 
-TODO: Write usage instructions here
+### Metric Tracking
+
+Hyperfocal allows you to report metrics to the system. You can view them,
+ as averages, mins, or maxs.
+
+To track a metric, use the following code in your application
+ `Hyperfocal.metric('metric_name', 'metric_value',  other_attributes_as_hash)`
 
-## Development
+The supported metric values are strings, and integers. If you report the metrics
+ as integers, you can use the average, min, and max reporting type in Hyperfocal
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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).
+### User Tracking
 
-## Contributing
+If you'd like to see more detailed information about your users in Hyperfocal,
+ you can report the User information to Hyperfocal.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hyperfocal.
+To report a user to Hyperfocal, simply use the following
+ `Hyperfocal.user(attributes_as_hash)`.
 
+The only required field for a user, is whatever unique identifier is used by
+ your application. This is required to be unique for all your users,
+ as if you report two differnet users with the same ID. We will overwrite the
+ previous information, as the reported information is taken as gospel.
 
 ## License
 

data/bin/hyperfocal

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require "hyperfocal/commands"
+Hyperfocal::Commands.start(ARGV)

data/lib/hyperfocal/commands.rb

@@ -0,0 +1,68 @@
+require 'hyperfocal'
+require 'net/http'
+require 'thor'
+require 'json'
+
+module Hyperfocal
+  class Commands < Thor
+    desc :setup, 'Set up Hyperfocal'
+    def setup(token=nil)
+      return say('A token is required. Please visit http://hyperfocal.io to get a setup token', :red) if token.nil?
+      return say('Invalid app token, please make sure you have it correct', :red) unless valid_token?(token)
+
+      if File.exists?(initializer_path)
+        say('Initializer already exists', :red)
+        say('You can view your app at http://hyperfocal.io or remove config/initializers/hyperfocal.rb and set it up as a new app', :red)
+      else
+        write_initializer(token)
+        activate_app(token)
+        say('Congratulations, your app is ready to send events to Hyperfocal', :green)
+      end
+    end
+
+    desc :uninstall, 'Uninstall Hyperfocal'
+    def uninstall
+      if File.exists?(initializer_path)
+        File.delete(initializer_path)
+        say('The Hyperfocal initializer has been removed.')
+        say('Removing the gem from your Gemfile, and code from your app will complete the installation')
+        say("We're sad to see you go, if there's anything we can do, drop us a line at support@hyperfocal.io")
+      else
+        say('Hyperfocal does not have a configuration file, there is nothing to uninstall', :red)
+      end
+    end
+
+    private
+
+    def initializer_path
+      File.expand_path(relative_initializer_path)
+    end
+
+    def relative_initializer_path
+      'config/initializers/hyperfocal.rb'
+    end
+
+    def write_initializer(token)
+      FileUtils.mkdir_p(File.dirname(initializer_path))
+
+      File.open(initializer_path, 'w') do |f|
+        f.puts <<-CONF
+Hyperfocal.configure do |config|
+  config.app_id = #{token}
+end
+        CONF
+      end
+    end
+
+    def activate_app(token)
+      uri = URI('http://api.hyperfocal.io/activate')
+      req = Net::HTTP.post_form(uri, { token: token })
+    end
+
+    def valid_token?(token)
+      req = Net::HTTP.get("api.hyperfocal.io", "/validate?token=#{token}")
+      return JSON.parse(req.to_s)['valid']
+    end
+  end
+end
+

data/lib/hyperfocal/record.rb

@@ -0,0 +1,2 @@
+module Hyperfocal
+  class

data/lib/hyperfocal/transmitter.rb

@@ -0,0 +1,17 @@
+module Hyperfocal
+  module Transmitter
+    module_function
+
+    def send(type, params)
+      url = URI(url_for(type))
+      Net::HTTP.post_form(url, params)
+    end
+
+    def url_for(type)
+      raise 'Unknown Tracking Type' unless %w[ event metric user ].include?(type)
+
+      host = Hyperfocal.host
+      return "#{host}/#{type}"
+    end
+  end
+end

data/lib/hyperfocal/version.rb

@@ -1,3 +1,3 @@
 module Hyperfocal
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/hyperfocal.rb

@@ -1,5 +1,59 @@
+require "yaml"
 require "hyperfocal/version"
+require "hyperfocal/transmitter"
 
 module Hyperfocal
-  # Your code goes here...
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+      configuration.host = 'https://api.hyperfocal.io'
+    end
+
+    def host
+      raise 'App ID Not Set' if configuration.app_id.nil?
+
+      configuration.host + '/track/' + configuration.app_id
+    end
+
+    def event(event, attrs = {})
+      send_request do
+        event_params = { event: attrs.merge(title: event) }
+        Transmitter.send('event', event_params)
+      end
+    end
+
+    def metric(metric, value, attrs = {})
+      send_request do
+        metric_params = { metric: attrs.merge(title: metric, value: value) }
+        Transmitter.send('metric', metric_params)
+      end
+    end
+
+    def user(attrs)
+      send_request do
+        user_params = { user: attrs }
+        Transmitter.send('user', user_params)
+      end
+    end
+
+    def send_request(&block)
+      thr = Thread.new do
+        yield
+      end
+      thr.join
+      thr.exit
+    end
+  end
+
+  class Configuration
+    attr_accessor :app_id
+    attr_reader   :host
+
+    def initialize
+      @host = 'https://api.hyperfocal.io'
+    end
+  end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: hyperfocal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- Aaron Miler
+- Pineworks Inc.
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-12-18 00:00:00.000000000 Z
+date: 2017-01-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -54,22 +68,18 @@ dependencies:
         version: '3.0'
 description: 
 email:
-- aaron@pineworks.io
-executables: []
+- support@pineworks.io
+executables:
+- hyperfocal
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- hyperfocal.gemspec
+- bin/hyperfocal
 - lib/hyperfocal.rb
+- lib/hyperfocal/commands.rb
+- lib/hyperfocal/record.rb
+- lib/hyperfocal/transmitter.rb
 - lib/hyperfocal/version.rb
 homepage: http://hyperfocal.io
 licenses:
@@ -95,5 +105,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A Ruby gem for reporting to hyperfocal.io
+summary: An event reporting app for Ruby
 test_files: []

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Aaron Miler
-
-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/Rakefile

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

data/bin/console

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

@@ -1,8 +0,0 @@
-#!/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/hyperfocal.gemspec

@@ -1,36 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hyperfocal/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "hyperfocal"
-  spec.version       = Hyperfocal::VERSION
-  spec.authors       = ["Aaron Miler"]
-  spec.email         = ["aaron@pineworks.io"]
-
-  spec.summary       = %q{A Ruby gem for reporting to hyperfocal.io}
-  spec.homepage      = "http://hyperfocal.io"
-  spec.license       = "MIT"
-
-  # 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'] = "https://rubygems.org"
-  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_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-end