twinkle-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40db9134efad382ac5af62130a65756ae9d70456
+  data.tar.gz: addded47d1815952ce2d730cc01c08694797b412
+SHA512:
+  metadata.gz: a82aea8ddc6264fb8a309ff6926e79ba91179daa931796ea30054522e7b402d5742576737d7d7651dcf3f368f1d6d92c3cdbcde0bdcfc8e314c90a31ab51d033
+  data.tar.gz: ff578bfb7b5b5a0e2d0cd0af25e196911434b3abf9f0a6bb2432e40b114a2c28d507efef6698b7c25f80883e7e0f51d1cee0b6192314202b52745697f3c3ed2c

data/.gitignore

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

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--tty
+--format progress
+--order random

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.3.0
+addons:
+  code_climate:
+    repo_token: ddf20deeb83c1502bf853910191b995e869ada3c5e00996a14d1eedd355b1c55
+before_install: gem install bundler -v 1.11.2
+script: bundle exec rake spec

data/Gemfile

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

data/README.md

@@ -0,0 +1,51 @@
+# Twinkle::Client
+
+[![Code Climate](https://codeclimate.com/github/bibendi/twinkle-client/badges/gpa.svg)](https://codeclimate.com/github/bibendi/twinkle-client)
+[![Test Coverage](https://codeclimate.com/github/bibendi/twinkle-client/badges/coverage.svg)](https://codeclimate.com/github/bibendi/twinkle-client/coverage)
+[![Build Status](https://travis-ci.org/bibendi/twinkle-client.svg?branch=master)](https://travis-ci.org/bibendi/twinkle-client)
+
+A ruby client for [Twinkle](https://github.com/bibendi/twinkle) notification service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twinkle-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twinkle-client
+
+## Usage
+
+#### Basic configuration
+```ruby
+Twinkle::Client.configure do |config|
+  config.endpoint = "http://example.com"
+  config.token = "hex-digest-user-token"
+end
+```
+
+#### Sending a message
+
+```ruby
+Twinkle::Client.create_message("deploy", "Release!")
+
+Twinkle::Client.create_message("sadness", exception)
+```
+
+## Development
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bibendi/twinkle-client.

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 "twinkle/client"
+
+# 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/lib/twinkle/client.rb

@@ -0,0 +1,57 @@
+require "curb"
+require "twinkle/client/version"
+require "twinkle/client/default_formatter"
+
+module Twinkle
+  module Client
+    Config = Struct.new(:endpoint, :token, :formatter)
+
+    def self.config
+      @config ||= Config.new.tap do |config|
+        config.formatter = ::Twinkle::Client::DefaultFormatter
+      end
+    end
+
+    def self.configure
+      yield config
+    end
+
+    def self.reset
+      @resources = nil
+      @config = nil
+    end
+
+    # Send a message
+    #
+    # channel - String The name of channel
+    # message - String|Exception A text message or failure object
+    # options - Hash
+    #           :formatter - Proc A formatter block (default: :simple)
+    def self.create_message(channel, message, options = {})
+      formatter = options.fetch(:formatter, config.formatter)
+      message = formatter.call(message)
+
+      post "/messages", channel: channel, message: message
+    end
+
+    private
+
+    def self.post(path, params = {})
+      add_default_params(params)
+      http = Curl.post(resource(path), params) do |client|
+        client.headers["Content-Type"] = "application/json"
+      end
+
+      http.body_str
+    end
+
+    def self.add_default_params(params)
+      params[:token] ||= config.token
+    end
+
+    def self.resource(path)
+      @resources ||= Hash.new({})
+      @resources[config.endpoint][path] ||= File.join(config.endpoint, path)
+    end
+  end
+end

data/lib/twinkle/client/default_formatter.rb

@@ -0,0 +1,22 @@
+module Twinkle
+  module Client
+    class DefaultFormatter
+      @backtrace_num_lines = 3
+
+      class << self
+        attr_accessor :backtrace_num_lines
+
+        def call(message)
+          formatted_message = message.message if message.respond_to?(:message)
+          formatted_message ||= message.to_s
+
+          if message.respond_to?(:backtrace)
+            formatted_message << "\n#{message.backtrace.take(@backtrace_num_lines).join("\n")}"
+          end
+
+          formatted_message
+        end
+      end
+    end
+  end
+end

data/lib/twinkle/client/version.rb

@@ -0,0 +1,5 @@
+module Twinkle
+  module Client
+    VERSION = "0.1.0"
+  end
+end

data/twinkle-client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'twinkle/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "twinkle-client"
+  spec.version       = Twinkle::Client::VERSION
+  spec.authors       = ["Michail Merkushin"]
+  spec.email         = ["merkushin.m.s@gmail.com"]
+
+  spec.summary       = %q{A ruby client for Twinkle notification service.}
+  spec.description   = %q{A ruby client for Twinkle notification service}
+  spec.homepage      = "https://github.com/bibendi/twinkle-client"
+
+  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_runtime_dependency "curb"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "webmock", "~> 1.24"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: twinkle-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michail Merkushin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+description: A ruby client for Twinkle notification service
+email:
+- merkushin.m.s@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/twinkle/client.rb
+- lib/twinkle/client/default_formatter.rb
+- lib/twinkle/client/version.rb
+- twinkle-client.gemspec
+homepage: https://github.com/bibendi/twinkle-client
+licenses: []
+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: A ruby client for Twinkle notification service.
+test_files: []