handiv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 721a25d6f64fcd6dad901e0d4394f534ad244970
+  data.tar.gz: ad9f20bd05589af1494c705cde5af8f8c19232ef
+SHA512:
+  metadata.gz: bbf9b37f6ee8966532ce25051ea770a6c6ca73c0ff5f9e13ca62bdb50f9623a46faa88f1968abfc54cd0b7135c3d0cccb032e34a56a06ae15628f2400bf07f11
+  data.tar.gz: ba6991592d29bc4c0128e10c2c35a75773aaec5cb6589e6cdb5a590238d75db2328cdf003fd1d8827d6f21f6e4e27e320f6f8ae44a9005b7cdce3676b85f6436

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,27 @@
+Rails:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/AlignParameters:
+  Enabled: true
+  EnforcedStyle: with_fixed_indentation
+
+Style/MultilineOperationIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Style/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Style/CaseIndentation:
+  Enabled: true
+  IndentWhenRelativeTo: end
+
+Style/SignalException:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# How to contribute
+
+I like to encourage you to contribute to the repository.
+This should be as easy as possible for you but there are a few things to consider when contributing.
+The following guidelines for contribution should be followed if you want to submit a pull request.
+
+## How to prepare
+
+* You need a [GitHub account](https://github.com/signup/free)
+* Submit an [issue ticket](https://github.com/handiv/handiv-ruby/issues) for your issue if the is no one yet.
+  * Describe the issue and include steps to reproduce if it's a bug.
+  * Ensure to mention the earliest version that you know is affected.
+* If you are able and want to fix this, fork the repository on GitHub
+
+## Make Changes
+
+* In your forked repository, create a topic branch for your upcoming patch. (e.g. `feature--autoplay` or `bugfix--ios-crash`)
+  * Usually this is based on the master branch.
+  * Create a branch based on master; `git branch
+  fix/master/my_contribution master` then checkout the new branch with `git
+  checkout fix/master/my_contribution`.  Please avoid working directly on the `master` branch.
+* Make sure you stick to the coding style that is used already.
+* Make use of the `.editorconfig`-file if provided with the repository.
+* Make commits of logical units and describe them properly.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+
+* If possible, submit tests to your patch / new feature so it can be tested easily.
+* Assure nothing is broken by running all the tests.
+
+## Submit Changes
+
+* Push your changes to a topic branch in your fork of the repository.
+* Open a pull request to the original repository and choose the right original branch you want to patch.
+  _Advanced users may use [`hub`](https://github.com/defunkt/hub#git-pull-request) gem for that._
+* If not done in commit messages (which you really should do) please reference and update your issue with the code changes. But _please do not close the issue yourself_.
+_Notice: You can [turn your previously filed issues into a pull-request here](http://issue2pr.herokuapp.com/)._
+* Even if you have write access to the repository, do not directly push or merge pull-requests. Let another team member review your pull request and approve.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'pry'
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Justas Palumickas
+
+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,37 @@
+# Handiv Ruby
+
+A Ruby client which communicate with Handiv server.
+
+## Getting Started
+
+### Install
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'handiv'
+```
+
+## Usage
+
+```ruby
+Handiv.configure do |config|
+  config.organization_id = '7b613512d9ca6545d37701efa1f2a0cc58c3b9ba'
+end
+```
+
+Report about performed task
+
+```ruby
+Handiv.report_task('task_id')
+```
+
+If you want to send a message about task specify an `message` argument
+
+```ruby
+Handiv.report_task('task_id', message: 'Successfully fetched 2 records')
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'handiv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'handiv'
+  spec.version       = Handiv::VERSION
+  spec.authors       = ['Justas Palumickas']
+  spec.email         = ['support@handiv.com']
+
+  spec.summary       = 'A gem that provides a client interface for Handiv'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/handiv/handiv-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+    .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '>= 0.7.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/handiv/configuration.rb

@@ -0,0 +1,61 @@
+module Handiv
+  class Configuration
+    class Error < StandardError; end
+
+    DEFAULT_HOST = 'handiv.com'.freeze
+
+    # Host that will be used for connections
+    attr_accessor :host
+
+    attr_accessor :ssl
+
+    # General authentication data
+    attr_accessor :organization_id
+    attr_accessor :app_id
+    attr_accessor :secret_token
+
+    # Timeout when waiting for the server to return data in seconds
+    attr_accessor :timeout
+
+    # Timeout waiting for the connection to open in seconds
+    attr_accessor :open_timeout
+
+    # Proxy information to pass to the HTTP adapter
+    attr_accessor :proxy
+
+    # Logger to use internally
+    attr_accessor :logger
+
+    def initialize
+      set_default_configs
+      set_faraday_configs
+    end
+
+    def ssl?
+      ssl
+    end
+
+    def uri
+      scheme = ssl? ? 'https' : 'http'
+      "#{scheme}://#{host}"
+    end
+
+    def verify!
+      raise Error, 'No organization id specified.' unless organization_id
+      raise Error, 'No app id specified.' unless app_id
+      raise Error, 'No secret token specified.' unless secret_token
+    end
+
+    private
+
+    def set_default_configs
+      @ssl = false
+      @host = DEFAULT_HOST
+    end
+
+    def set_faraday_configs
+      @timeout = 2
+      @open_timeout = 2
+    end
+  end
+end

data/lib/handiv/connection.rb

@@ -0,0 +1,58 @@
+require 'faraday'
+require 'json'
+
+module Handiv
+  class Connection
+    USER_AGENT = "handiv-ruby/#{Handiv::VERSION}".freeze
+
+    attr_reader :connection
+
+    def initialize
+      @connection = set_connection
+    end
+
+    def send_data(path, data)
+      config.verify!
+
+      response = post_data(path, data)
+      response.status
+    rescue => e
+      Handiv.logger.error "Failed to send a message (#{e.class} - #{e.message})"
+      500 # Return status
+    end
+
+    private
+
+    def post_data(path, data)
+      connection.post do |req|
+        req.url(path)
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['Authorization'] = "Token token=#{config.secret_token}"
+        req.body = data.to_json
+      end
+    end
+
+    def ping_url
+      "#{config.uri}/ping/#{config.organization_id}/#{config.app_id}"
+    end
+
+    def set_connection
+      conn = Faraday.new(url: ping_url)
+
+      config_general_options(conn)
+
+      conn
+    end
+
+    def config_general_options(conn)
+      conn.headers[:user_agent] = USER_AGENT
+      conn.options[:proxy] = config.proxy if config.proxy
+      conn.options[:timeout] = config.timeout if config.timeout
+      conn.options[:open_timeout] = config.open_timeout if config.open_timeout
+    end
+
+    def config
+      Handiv.configuration
+    end
+  end
+end

data/lib/handiv/logger.rb

@@ -0,0 +1,31 @@
+require 'logger'
+
+module Handiv
+  class Logger
+    LOG_PREFIX = '** [Handiv] '.freeze
+    LOG_LEVELS = [:fatal, :error, :warn, :info, :debug].freeze
+
+    LOG_LEVELS.each do |level|
+      define_method(level)do |*args, &block|
+        msg = args[0] # Block-level default args is a 1.9 feature
+        msg ||= block.call if block
+
+        logger.send(level, "#{LOG_PREFIX}#{msg}")
+      end
+    end
+
+    def logger
+      custom_logger || default_logger
+    end
+
+    private
+
+    def default_logger
+      @default_logger ||= ::Logger.new(STDOUT)
+    end
+
+    def custom_logger
+      Handiv.configuration.logger
+    end
+  end
+end

data/lib/handiv/tasks/reporter.rb

@@ -0,0 +1,39 @@
+module Handiv
+  module Tasks
+    class Reporter
+      attr_reader :task_id, :options
+
+      def initialize(task_id, options = {})
+        @task_id = task_id
+        @options = options
+      end
+
+      def report
+        Handiv.logger.debug "Sending event about task #{task_id}"
+
+        status = connection.send_data("tasks/#{task_id}", options)
+        log_status(status)
+
+        status == 200 # Return success
+      end
+
+      private
+
+      def log_status(status)
+        case status
+        when 200
+          Handiv.logger.debug "Successfully sent event about task #{task_id}"
+        when 404
+          Handiv.logger.error(
+            "Failed to send event for #{task_id} task.")
+        else
+          Handiv.logger.error "Failed to send event about task #{task_id}"
+        end
+      end
+
+      def connection
+        @connection ||= Connection.new
+      end
+    end
+  end
+end

data/lib/handiv/version.rb

@@ -0,0 +1,3 @@
+module Handiv
+  VERSION = '0.1.0'.freeze
+end

data/lib/handiv.rb

@@ -0,0 +1,26 @@
+require 'handiv/configuration'
+require 'handiv/logger'
+require 'handiv/connection'
+require 'handiv/version'
+
+require 'handiv/tasks/reporter'
+
+module Handiv
+  class << self
+    def logger
+      @logger ||= Logger.new
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration) if block_given?
+    end
+
+    def report_task(task_id, options = {})
+      Tasks::Reporter.new(task_id, options).report
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: handiv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justas Palumickas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A gem that provides a client interface for Handiv
+email:
+- support@handiv.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- handiv.gemspec
+- lib/handiv.rb
+- lib/handiv/configuration.rb
+- lib/handiv/connection.rb
+- lib/handiv/logger.rb
+- lib/handiv/tasks/reporter.rb
+- lib/handiv/version.rb
+homepage: https://github.com/handiv/handiv-ruby
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A gem that provides a client interface for Handiv
+test_files: []