powertrack_v2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 224bad738e8ef15952bc6252b362d516de828de4
+  data.tar.gz: a0a7bf95a7223c9f1f18f9ae4134582549ee5f54
+SHA512:
+  metadata.gz: 6a668a7da86f731575c161b2a3709e43ed10f4f820d0bd3bcee9ff74ca361c2ee3349eba4a0b6c53a61c7ae3a758d9343efcef734b833ef84b18a88781d89f6b
+  data.tar.gz: c377b9e8b4ccc673adbed23ab7dab9e2922f273698692c94d87b0c3b48beb7f5ec1686614f9f1c4d8d45c62d88e2a9b73a71c9f2e8d0fa4a81428b1fe5d124e0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2016 NUVI
+
+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,100 @@
+PowerTrackV2
+=
+
+A Ruby client for managing PowerTrack 2.0 rules, as well as streaming.
+
+Authentication
+==
+
+First, authentication is managed through environment variables. If you're
+unfamiliar with this practice, check out [The Rubyist's Guide to Environment
+Variables](http://blog.honeybadger.io/ruby-guide-environment-variables/).
+
+In your shell:
+
+```bash
+export POWERTRACK_USERNAME=<your_username>
+export POWERTRACK_PASSWORD=<your_password>
+```
+
+Rule Management
+==
+
+To add rules to your stream:
+
+```ruby
+require 'powertrack_v2'
+
+url = PowerTrackV2.rules_url(publisher, account_name, stream_label)
+
+rules = [
+  PowerTrackV2::Rule.new('rule_value', 'optional_rule_tag'),
+  PowerTrackV2::Rule.new('another_value')
+]
+
+response_body = PowerTrackV2.add_rules(url, rules)
+```
+
+To remove rules from your stream:
+
+```ruby
+require 'powertrack_v2'
+
+url = PowerTrackV2.rules_url(publisher, account_name, stream_label)
+
+rules = [
+  Rule.new('rule_value', 'optional_rule_tag'),
+  Rule.new('another_value')
+]
+
+response_body = PowerTrackV2.remove_rules(url, rules)
+```
+
+To get all rules for your stream:
+
+```ruby
+require 'powertrack_v2'
+
+url = PowerTrackV2.rules_url(publisher, account_name, stream_label)
+
+response_body = PowerTrackV2.get_rules(url, rules)
+```
+
+Streaming
+==
+
+To stream from powertrack:
+
+```ruby
+require 'powertrack_v2'
+
+url = PowerTrackV2.stream_url(publisher, account, stream_label)
+
+PowerTrackV2.stream(url) do |activity|
+  puts activity # or whatever you want to do with it.
+end
+```
+
+Some things to note about streaming:
+
+1. The stream function is infinitely blocking, so your streamer should be a
+   separate process from your rule manager process.
+1. Your block is called for every published activity.
+1. The published activity is a raw, unprocessed response from PowerTrack. This
+   library makes no assumptions about what you want to do with the data being
+   streamed in, and leaves processing up to you.
+1. If the connection drops, this library will automatically reconnect using an
+   exponential backoff algorithm.
+1. PowerTrack sends a "\\r\\n" heartbeat every few seconds. By default, the
+   streamer discards it so you don't have to worry about it. If you want it to
+   pass you the heartbeat, simply add an option to the stream function:
+
+```ruby
+require 'powertrack_v2'
+
+url = PowerTrackV2.stream_url(publisher, account, stream_label)
+
+PowerTrackV2.stream(url, ignore_heartbeat: false) do |activity|
+  puts activity # or whatever you want to do with it.
+end
+```

data/lib/powertrack_v2/errors.rb

@@ -0,0 +1,28 @@
+module PowerTrackV2
+  module Errors
+    class BadRequestError         < StandardError; end
+    class UnauthorizedError       < StandardError; end
+    class NoSuchResourceError     < StandardError; end
+    class RateLimitedError        < StandardError; end
+    class ServiceUnavailableError < StandardError; end
+    class UnexpectedStatusError   < StandardError; end
+
+    class InvalidRuleError        < StandardError; end
+    class TooManyRulesError       < StandardError; end
+
+    ERROR_MAP = {
+      400 => BadRequestError,
+      401 => UnauthorizedError,
+      404 => NoSuchResourceError,
+      429 => RateLimitedError,
+      503 => ServiceUnavailableError
+    }
+
+    def self.raise_error_for_code(code)
+      message = code.to_s
+
+      raise ERROR_MAP[code], message if ERROR_MAP[code]
+      raise UnexpectedStatusError, message
+    end
+  end
+end

data/lib/powertrack_v2/http.rb

@@ -0,0 +1,62 @@
+require 'base64'
+require 'httpclient'
+require 'exponential_backoff'
+
+module PowerTrackV2
+  module HTTP
+    def self.auth_digest(username, password)
+      ::Base64.strict_encode64("#{username}:#{password}")
+    end
+
+    def self.auth_header(auth_digest)
+      {'Authorization' => "Basic #{auth_digest}"}
+    end
+
+    def self.headers(headers = {})
+      username = ENV['POWERTRACK_USERNAME']
+      password = ENV['POWERTRACK_PASSWORD']
+
+      digest = auth_digest(username, password)
+      headers.merge auth_header(digest)
+    end
+
+    def self.get(url, headers={})
+      ::HTTPClient.get(url, nil, headers)
+    end
+
+    def self.post(url, body, headers={})
+      ::HTTPClient.post(url, body, headers)
+    end
+
+    def self.stream(url, headers = {}, opts = { ignore_heartbeat: true }, &block)
+      http = ::HTTPClient.new
+      backoff = ::ExponentialBackoff.new(1, 120)
+
+      while true
+        begin
+          connection = connect(url, headers)
+          stream_from(connection, opts, backoff, &block)
+        rescue StandardError => e
+          sleep(backoff.next_interval)
+        end
+      end
+    end
+
+    private
+
+    def self.connect(url, headers)
+      http = ::HTTPClient.new
+      http.get_async(url, nil, headers)
+    end
+
+    def self.stream_from(connection, opts, backoff, &block)
+      ignore_heartbeat = opts[:ignore_heartbeat]
+      content = connection.pop.content
+      backoff.clear
+      until connection.finished?
+        next_response = content.gets
+        block.call(next_response) unless ignore_heartbeat && next_response == "\r\n"
+      end
+    end
+  end
+end

data/lib/powertrack_v2/rule.rb

@@ -0,0 +1,78 @@
+require 'powertrack_v2/http'
+require 'powertrack_v2/errors'
+require 'multi_json'
+
+module PowerTrackV2
+  class Rule
+    MAX_TAG_LENGTH = 255
+    MAX_VALUE_LENGTH = 2048
+
+    attr_accessor :value, :tag
+
+    def initialize(value, tag=nil)
+      @value = value
+      @tag = tag
+    end
+
+    def as_json
+      hash = {
+        value: @value
+      }
+      hash[:tag] = @tag if @tag && !@tag.empty?
+      hash
+    end
+
+    def valid?
+      return false if @value.nil? || @value.length > MAX_VALUE_LENGTH
+      return false if @tag && @tag.length > MAX_TAG_LENGTH
+      true
+    end
+
+    def self.url(publisher, account, stream_label)
+      "https://gnip-api.#{publisher}.com/rules/powertrack/accounts/#{account}/publishers/#{publisher}/#{stream_label}.json"
+    end
+
+    def self.get(url, optional_headers={})
+      headers = PowerTrackV2::HTTP.headers(optional_headers)
+      response = PowerTrackV2::HTTP.get(url, headers)
+      handle_response(response)
+    end
+
+    def self.handle_response(response)
+      return response.body if response.status == 200 || response.status < 300
+      return PowerTrackV2::Errors.raise_error_for_code(response.status)
+    end
+
+    DEFAULT_POST_HEADERS = {
+      'Content-Type' => 'application/json'
+    }
+
+    def self.post(url, rules, optional_headers={})
+      validate(rules)
+
+      base_headers = DEFAULT_POST_HEADERS.merge(optional_headers)
+      headers = PowerTrackV2::HTTP.headers(base_headers)
+
+      body = prepare_rules(rules)
+
+      response = PowerTrackV2::HTTP.post(url, body, headers)
+      handle_response(response)
+    end
+
+    def self.delete(url, rules, optional_headers={})
+      post(url + '?_method=delete', rules, optional_headers)
+    end
+
+    def self.validate(rules)
+      raise ::PowerTrackV2::Errors::TooManyRulesError if rules.length > 5000
+      raise ::PowerTrackV2::Errors::InvalidRuleError unless rules.all? &:valid?
+    end
+
+    private
+
+    def self.prepare_rules(rules)
+      rules = rules.map {|rule| rule.as_json}
+      ::MultiJson.dump({rules: rules})
+    end
+  end
+end

data/lib/powertrack_v2/stream.rb

@@ -0,0 +1,12 @@
+module PowerTrackV2
+  module Stream
+    def self.url(publisher, account, stream_label)
+      "https://gnip-stream.#{publisher}.com/stream/powertrack/accounts/#{account}/publishers/#{publisher}/#{stream_label}.json"
+    end
+
+    def self.stream(url, opts = { ignore_heartbeat: true }, &block)
+      headers = PowerTrackV2::HTTP.headers
+      PowerTrackV2::HTTP.stream(url, headers, opts, &block)
+    end
+  end
+end

data/lib/powertrack_v2.rb

@@ -0,0 +1,30 @@
+require 'powertrack_v2/rule'
+require 'powertrack_v2/stream'
+require 'powertrack_v2/http'
+require 'powertrack_v2/errors'
+
+module PowerTrackV2
+  def self.stream_url(publisher, account, stream_label)
+    PowerTrackV2::Stream.url(publisher, account, stream_label)
+  end
+
+  def self.rules_url(publisher, account, stream_label)
+    PowerTrackV2::Rule.url(publisher, account, stream_label)
+  end
+
+  def self.add_rules(url, rules, optional_headers = {})
+    PowerTrackV2::Rule.post(url, rules, optional_headers)
+  end
+
+  def self.remove_rules(url, rules, optional_headers = {})
+    PowerTrackV2::Rule.delete(url, rules, optional_headers)
+  end
+
+  def self.get_rules(url, optional_headers = {})
+    PowerTrackV2::Rule.get(url, optional_headers)
+  end
+
+  def self.stream(url, opts = { ignore_heartbeat: true }, &block)
+    PowerTrackV2::Stream.stream(url, opts, &block)
+  end
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: powertrack_v2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cody Poll
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  name: httpclient
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.16.0
+  name: march_hare
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.16.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  name: exponential-backoff
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  name: multi_json
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  name: pry
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  name: pry-nav
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  name: json_pure
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.8.4
+  name: minitest
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.8.4
+description: A simple library for streaming from Powertrack 2.0, as well as managing rules for your stream.
+email: developers@nuviapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/powertrack_v2.rb
+- lib/powertrack_v2/errors.rb
+- lib/powertrack_v2/http.rb
+- lib/powertrack_v2/rule.rb
+- lib/powertrack_v2/stream.rb
+homepage: http://github.com/nuvi/powertrack_v2
+licenses:
+- MIT
+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.4.8
+signing_key:
+specification_version: 4
+summary: Powertrack 2.0 client for Ruby
+test_files: []