flowdock_rails 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf3e6b3111693e70f099356cc2ba9f22e3629dba
+  data.tar.gz: 8303560118c02b854f6f8f3fc80386c5c9dd63ee
+SHA512:
+  metadata.gz: 4495f9419d996bd9673d4b97b8cf5da8541edc16ec249a46f1bd3d09e0ca515341ed34c62211ae08836a083c0210032ddbde28c75a97c5fb20c370202e950368
+  data.tar.gz: e4cf58b7ec847fee6d45d4870a1334bf6ba07787e7b6a7daaa2c45d315f7326aa4b70396b6f7364a6b653e28d1c2fc23df03276ba1a36980a3ee63f99423e1b4

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/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at oscar_alan@hotmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Oscar Rocha
+
+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,60 @@
+# Flowdock Rails
+
+Simple to post message to flowdock
+
+## Installation
+
+Add this line to your application's Gemfile:
+```rb
+gem 'flowdock_rails'
+```
+
+## Usage
+
+* Add initializer to use yor config
+```sh
+rails g flowdock_rails:config
+```
+
+Configure
+* sources
+* environments
+```rb
+# config/initializers/flowdock_rails.rb
+require 'flowdock_rails'
+
+FlowdockRails.configure do |config|
+  # You can configure more than one source.
+  # https://www.flowdock.com/api/sources
+  #
+  config.sources = { source_name: 'flowdock_token' }
+
+  # Configure env allowed to post messages
+  # default: production
+  #
+  config.environments = %w(production development)
+end
+```
+
+Sample
+```ruby
+# Message
+attributes = { text: 'Ok', tags: %w(a b) }
+message = FlowdockRails::Message.new(attributes)
+
+flow = FlowdockRails::Flowdock.new(:source_name)
+flow.post_message(message)
+```
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/aaroalan/flowdock_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'flowdock_rails'
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/flowdock_rails.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flowdock_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'flowdock_rails'
+  spec.version       = FlowdockRails::VERSION
+  spec.authors       = ['Oscar Rocha']
+  spec.email         = ['oscar_alan@hotmail.com']
+
+  spec.summary       = 'Flowdock connection'
+  spec.description   = 'Connect flowdock using source feature from Rails'
+  spec.homepage      = 'https://github.com/aaroalan'
+  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_runtime_dependency 'faraday', '~> 0.9'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.10'
+  spec.add_runtime_dependency 'activerecord', '~> 4.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'byebug', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 0'
+end

data/lib/flowdock_rails/configuration.rb

@@ -0,0 +1,19 @@
+module FlowdockRails
+  class Configuration
+    attr_accessor :sources, :environments
+
+    def initialize(sources = {})
+      @sources = sources
+      @environments = %w(production)
+    end
+
+    def valid_env?
+      @environments.include?(ENV['RAILS_ENV'] || 'development')
+    end
+
+    def method_missing(m)
+      return unless @sources[m]
+      @sources[m]
+    end
+  end
+end

data/lib/flowdock_rails/models/flowdock.rb

@@ -0,0 +1,35 @@
+module FlowdockRails
+  class Flowdock
+    include FlowdockRails::Utils::Network
+
+    attr_reader :source
+
+    def initialize(source)
+      @source = source
+      @flow_token = FlowdockRails.configuration.send(source)
+    end
+
+    def ready?
+      !@flow_token.nil?
+    end
+
+    def post_message(message)
+      return unless FlowdockRails.configuration.valid_env?
+      raise 'Instance is not ready' unless ready?
+      params = format_params(message)
+      response = post('/messages', params)
+      message.thread_id = response.body['thread_id']
+      message.sent
+      message
+    end
+
+    private
+
+    def format_params(message)
+      {
+        thread_id: message.thread_id, content: message.text.to_s,
+        tags: message.format_tags, flow_token: @flow_token, event: 'message'
+      }.reject { |_, v| v.nil? }
+    end
+  end
+end

data/lib/flowdock_rails/models/message.rb

@@ -0,0 +1,35 @@
+module FlowdockRails
+  # Create a message you can apply markdown to text multile line
+  # text
+  class Message
+    attr_accessor :thread_id, :text, :tags, :lines
+    def initialize(attributes = {})
+      @thread_id = attributes[:thread_id]
+      @text = attributes[:text]
+      @tags = attributes[:tags] || []
+      @lines = attributes[:lines] || []
+      @sent = false
+    end
+
+    def format_tags
+      @tags.map { |e| '#' + e.to_s }.join(',')
+    end
+
+    def thread?
+      !@thread_id.nil?
+    end
+
+    def sent?
+      @sent
+    end
+
+    def sent
+      @sent = true
+    end
+
+    def text
+      return lines.join("\n") if @lines.any?
+      @text
+    end
+  end
+end

data/lib/flowdock_rails/utils/network.rb

@@ -0,0 +1,25 @@
+require 'faraday_middleware'
+
+module FlowdockRails
+  module Utils
+    module Network
+      def connection
+        @conn ||= Faraday.new(url: 'https://api.flowdock.com') do |conn|
+          conn.request  :url_encoded
+          conn.response :logger
+          conn.response :json
+          conn.adapter  Faraday.default_adapter
+        end
+      end
+
+      def post(url, params = {})
+        connection.post do |req|
+          req.url url
+          req.headers['Content-Type'] = 'application/json'
+          req.headers['X-flowdock-wait-for-message'] = 'true'
+          req.body = params.to_json
+        end
+      end
+    end
+  end
+end

data/lib/flowdock_rails/version.rb

@@ -0,0 +1,3 @@
+module FlowdockRails
+  VERSION = "0.1.1"
+end

data/lib/flowdock_rails.rb

@@ -0,0 +1,25 @@
+require 'flowdock_rails/version'
+require 'active_support'
+
+module FlowdockRails
+  extend ActiveSupport::Autoload
+  autoload :Configuration
+
+  autoload_under 'models' do
+    autoload :Flowdock
+    autoload :Message
+  end
+
+  module Utils
+    extend ActiveSupport::Autoload
+    autoload :Network
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

data/lib/generators/flowdock_rails/config_generator.rb

@@ -0,0 +1,12 @@
+module FlowdockRails
+  module Generators # :nodoc:
+    class ConfigGenerator < Rails::Generators::Base # :nodoc:
+      source_root File.expand_path('../templates', __FILE__)
+      desc 'Install flowdock rails config'
+
+      def config
+        template 'config.rb', 'config/initializers/flowdock_rails.rb'
+      end
+    end
+  end
+end

data/lib/generators/flowdock_rails/templates/config.rb

@@ -0,0 +1,13 @@
+require 'flowdock_rails'
+
+FlowdockRails.configure do |config|
+  # You can configure more than one source.
+  # https://www.flowdock.com/api/sources
+  #
+  # config.sources = { main: 'token', bugs: 'token' }
+
+  # Configure env allowed to post messages
+  # default: production
+  #
+  # config.environments = %w(production)
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: flowdock_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Oscar Rocha
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-10 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Connect flowdock using source feature from Rails
+email:
+- oscar_alan@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flowdock_rails.gemspec
+- lib/flowdock_rails.rb
+- lib/flowdock_rails/configuration.rb
+- lib/flowdock_rails/models/flowdock.rb
+- lib/flowdock_rails/models/message.rb
+- lib/flowdock_rails/utils/network.rb
+- lib/flowdock_rails/version.rb
+- lib/generators/flowdock_rails/config_generator.rb
+- lib/generators/flowdock_rails/templates/config.rb
+homepage: https://github.com/aaroalan
+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: Flowdock connection
+test_files: []