idobata_hook 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e2c15c01a918c8cf2894618e31a710025cf57cd
+  data.tar.gz: a0ee2cafffdabfac256fe98d5a9bc583d53b49ed
+SHA512:
+  metadata.gz: 4c549fcf485c2fbfda2b497337e5952dc169a24518c9c16a98834cad6224c2205cb6c54525534f0fa380ffa5860a18cb8ad0a3905da92a31fab24f5b94842029
+  data.tar.gz: 9e25eae5b251381c6bc0e73983fd096bd1cefb55a183ce9bf2eca2a92d6abced5f9c2af72c92a0356191da88a078e320fb3b254babb9811abb03444e96d72e8c

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+script: bundle exec rspec

data/Gemfile

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

data/LICENSE.txt

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

data/README.md

@@ -0,0 +1,45 @@
+# IdobataHook
+
+A client for Idobata's Generic Hook
+
+[![Build Status](https://travis-ci.org/fukayatsu/idobata_hook.svg?branch=master)](https://travis-ci.org/fukayatsu/idobata_hook)
+[![Coverage Status](https://img.shields.io/coveralls/fukayatsu/idobata_hook.svg)](https://coveralls.io/r/fukayatsu/idobata_hook)
+[![Code Climate](https://codeclimate.com/github/fukayatsu/idobata_hook.png)](https://codeclimate.com/github/fukayatsu/idobata_hook)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'idobata_hook'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install idobata_hook
+
+## Usage
+
+```ruby
+client = IdobataHook::Client.new("https://idobata.io/hook/generic/***")
+client.send('hello, world')
+client.send("<h1>hi</h1>", format: :html)
+client.send('Look at this', image_path: '/path/to/image.png')
+client.send([
+  {'label-success' => 'build passing!' }, #=> <span class="label label-success">build passing!</span>
+  { badge: '123' },                       #=> <span class="badge">123</span>
+  { emoji: 'smile'},                      #=> <img class="emoji" alt=":smile:" src="/images/emoji/smile.png" height="20" width="20">
+  "Foooo!",                               #=> Foooo!
+  { fa: 'camera-retro' },                 #=> <i class="fa fa-camera-retro"></i>
+])
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/fukayatsu/idobata_hook/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/idobata_hook.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'idobata_hook/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "idobata_hook"
+  spec.version       = IdobataHook::VERSION
+  spec.authors       = ["fukayatsu"]
+  spec.email         = ["fukayatsu@gmail.com"]
+  spec.summary       = %q{A client for Idobata's Generic Hook}
+  spec.description   = %q{A client for Idobata's Generic Hook}
+  spec.homepage      = "https://github.com/fukayatsu/idobata_hook"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday',    '~> 0.9.0'
+  spec.add_dependency 'mime-types', '~> 1.25.1'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'coveralls'
+end

data/lib/idobata_hook/client.rb

@@ -0,0 +1,39 @@
+require 'faraday'
+require 'mime/types'
+require 'idobata_hook/source'
+
+module IdobataHook
+  class Client
+    def initialize(hook_url)
+      @hook_url = hook_url
+    end
+
+    def send(messages, format: nil, image_path: nil)
+      source = Source.new(messages)
+      params = { source: source.to_s }
+      params[:format] = :html if format.to_s == 'html' || source.force_html?
+      params[:image]  = image_io(image_path) if image_path
+      http_client.post(nil, params)
+    end
+
+  private
+
+    def image_io(image_path)
+      mime_type  = MIME::Types.type_for(image_path).first.simplified
+      Faraday::UploadIO.new(image_path, mime_type)
+    end
+
+    def http_client
+      @faraday ||= Faraday.new(url: @hook_url, headers: default_headers) do |conn|
+        conn.request  :multipart
+        conn.request  :url_encoded             # form-encode POST params
+        conn.response :logger                  # log requests to STDOUT
+        conn.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+
+    def default_headers
+      { 'User-Agent' => "RubyGems::IdobataHook / #{IdobataHook::VERSION} " }
+    end
+  end
+end

data/lib/idobata_hook/source.rb

@@ -0,0 +1,51 @@
+module IdobataHook
+  class Source
+    def initialize(*messages)
+      @text, @force_html = parse(messages.flatten)
+    end
+
+    def force_html?
+      @force_html
+    end
+
+    def to_s
+      @text
+    end
+
+    def parse(messages)
+      force_html = false
+      text = messages.map do |message|
+        next message if message.is_a? String
+        force_html ||= true
+        Source.htmlize(message)
+      end.join
+      [text, force_html]
+    end
+
+    class << self
+      def htmlize(message)
+        return message if message.is_a? String
+
+        type, text = message.first
+        case type.to_s
+        when 'label'
+          %(<span class="label">#{text}</span>)
+        when /label-(.+)/
+          %(<span class="label label-#{$1}">#{text}</span>)
+        when 'badge'
+          %(<span class="badge">#{text}</span>)
+        when /badge-(.+)/
+          %(<span class="badge badge-#{$1}">#{text}</span>)
+        when 'emoji'
+          %(<img class="emoji" alt=":#{text}:" src="/images/emoji/#{text}.png">)
+        when 'fa'
+          %(<i class="fa fa-#{text}"></i>)
+        when 'commit-id'
+          %(<span class="commit-id">#{text}</span>)
+        else
+          raise "unsupported type: #{type}"
+        end
+      end
+    end
+  end
+end

data/lib/idobata_hook/version.rb

@@ -0,0 +1,3 @@
+module IdobataHook
+  VERSION = "0.0.1"
+end

data/lib/idobata_hook.rb

@@ -0,0 +1,2 @@
+require "idobata_hook/version"
+require 'idobata_hook/client'

data/spec/idobata_hook/client_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe IdobataHook::Client do
+  subject(:client) { described_class.new('https://idobata.io/hook/generic/api-key-123abc') }
+
+  describe '#send' do
+    it 'send plain text' do
+      expect(subject).to receive_message_chain(:http_client, :post).with(nil, source: "text message")
+      response = client.send('text message')
+    end
+
+    it 'send html text' do
+      expect(subject).to receive_message_chain(:http_client, :post).with(nil, source: "<h1>html</h1>", format: :html)
+      response = client.send('<h1>html</h1>', format: :html)
+    end
+
+    it 'send text and image' do
+      expect(subject).to receive(:image_io).with('~/sushi.png') { '[sushi io]' }
+      expect(subject).to receive_message_chain(:http_client, :post).with(nil, source: "Look at this!", image: '[sushi io]')
+      response = client.send('Look at this!', image_path: '~/sushi.png')
+    end
+  end
+end

data/spec/idobata_hook/source_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe IdobataHook::Source do
+  describe '#new' do
+    subject(:source) { described_class.new(message) }
+
+    context 'only strings' do
+      let(:message) { ['aaa', 'bbb'] }
+      it 'joins strings' do
+        expect(subject.to_s).to eq('aaabbb')
+      end
+      it 'not force_html' do
+        expect(subject.force_html?).to be false
+      end
+    end
+
+    context 'with label' do
+      let(:message) { ['aaa', {label: 'bar'}, 'baz'] }
+      it 'joins strings and html' do
+        expect(subject.to_s).to eq('aaa<span class="label">bar</span>baz')
+      end
+      it 'force_html' do
+        expect(subject.force_html?).to be true
+      end
+    end
+  end
+
+  describe '.htmlize' do
+    it 'just a string' do
+      expect(described_class.htmlize('abc'))
+        .to eq('abc')
+    end
+    it 'default label' do
+      expect(described_class.htmlize({label: 'foo'}))
+        .to eq('<span class="label">foo</span>')
+    end
+    it 'important label' do
+      expect(described_class.htmlize({'label-important' => 'bar'}))
+        .to eq('<span class="label label-important">bar</span>')
+    end
+    it 'default badge' do
+      expect(described_class.htmlize({badge: '123'}))
+        .to eq('<span class="badge">123</span>')
+    end
+    it 'important badge' do
+      expect(described_class.htmlize({'badge-important' => '234'}))
+        .to eq('<span class="badge badge-important">234</span>')
+    end
+    it 'emoji' do
+      expect(described_class.htmlize({emoji: :smile}))
+        .to eq('<img class="emoji" alt=":smile:" src="/images/emoji/smile.png">')
+    end
+    it 'font awesome' do
+      expect(described_class.htmlize({fa: 'camera-retro'}))
+        .to eq('<i class="fa fa-camera-retro"></i>')
+    end
+    it 'commit-id' do
+      expect(described_class.htmlize({'commit-id' => '123abc'}))
+        .to eq('<span class="commit-id">123abc</span>')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,82 @@
+require 'coveralls'
+Coveralls.wear!
+require 'idobata_hook'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: idobata_hook
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- fukayatsu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A client for Idobata's Generic Hook
+email:
+- fukayatsu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- idobata_hook.gemspec
+- lib/idobata_hook.rb
+- lib/idobata_hook/client.rb
+- lib/idobata_hook/source.rb
+- lib/idobata_hook/version.rb
+- spec/idobata_hook/client_spec.rb
+- spec/idobata_hook/source_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/fukayatsu/idobata_hook
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A client for Idobata's Generic Hook
+test_files:
+- spec/idobata_hook/client_spec.rb
+- spec/idobata_hook/source_spec.rb
+- spec/spec_helper.rb