flowdock_rails 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: cf3e6b3111693e70f099356cc2ba9f22e3629dba
4
+ data.tar.gz: 8303560118c02b854f6f8f3fc80386c5c9dd63ee
5
+ SHA512:
6
+ metadata.gz: 4495f9419d996bd9673d4b97b8cf5da8541edc16ec249a46f1bd3d09e0ca515341ed34c62211ae08836a083c0210032ddbde28c75a97c5fb20c370202e950368
7
+ data.tar.gz: e4cf58b7ec847fee6d45d4870a1334bf6ba07787e7b6a7daaa2c45d315f7326aa4b70396b6f7364a6b653e28d1c2fc23df03276ba1a36980a3ee63f99423e1b4
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.12.5
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at oscar_alan@hotmail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in flowdock_rails.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Oscar Rocha
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,60 @@
1
+ # Flowdock Rails
2
+
3
+ Simple to post message to flowdock
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+ ```rb
9
+ gem 'flowdock_rails'
10
+ ```
11
+
12
+ ## Usage
13
+
14
+ * Add initializer to use yor config
15
+ ```sh
16
+ rails g flowdock_rails:config
17
+ ```
18
+
19
+ Configure
20
+ * sources
21
+ * environments
22
+ ```rb
23
+ # config/initializers/flowdock_rails.rb
24
+ require 'flowdock_rails'
25
+
26
+ FlowdockRails.configure do |config|
27
+ # You can configure more than one source.
28
+ # https://www.flowdock.com/api/sources
29
+ #
30
+ config.sources = { source_name: 'flowdock_token' }
31
+
32
+ # Configure env allowed to post messages
33
+ # default: production
34
+ #
35
+ config.environments = %w(production development)
36
+ end
37
+ ```
38
+
39
+ Sample
40
+ ```ruby
41
+ # Message
42
+ attributes = { text: 'Ok', tags: %w(a b) }
43
+ message = FlowdockRails::Message.new(attributes)
44
+
45
+ flow = FlowdockRails::Flowdock.new(:source_name)
46
+ flow.post_message(message)
47
+ ```
48
+
49
+ ## Development
50
+
51
+ 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.
52
+
53
+ ## Contributing
54
+
55
+ 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.
56
+
57
+
58
+ ## License
59
+
60
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task default: :spec
data/bin/console ADDED
@@ -0,0 +1,7 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'flowdock_rails'
5
+
6
+ require 'irb'
7
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
@@ -0,0 +1,31 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'flowdock_rails/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'flowdock_rails'
8
+ spec.version = FlowdockRails::VERSION
9
+ spec.authors = ['Oscar Rocha']
10
+ spec.email = ['oscar_alan@hotmail.com']
11
+
12
+ spec.summary = 'Flowdock connection'
13
+ spec.description = 'Connect flowdock using source feature from Rails'
14
+ spec.homepage = 'https://github.com/aaroalan'
15
+ spec.license = 'MIT'
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = 'exe'
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ['lib']
21
+
22
+ spec.add_runtime_dependency 'faraday', '~> 0.9'
23
+ spec.add_runtime_dependency 'faraday_middleware', '~> 0.10'
24
+ spec.add_runtime_dependency 'activerecord', '~> 4.1'
25
+
26
+ spec.add_development_dependency 'bundler', '~> 1.12'
27
+ spec.add_development_dependency 'rake', '~> 10.0'
28
+ spec.add_development_dependency 'rspec', '~> 3.0'
29
+ spec.add_development_dependency 'byebug', '~> 3.0'
30
+ spec.add_development_dependency 'webmock', '~> 0'
31
+ end
@@ -0,0 +1,19 @@
1
+ module FlowdockRails
2
+ class Configuration
3
+ attr_accessor :sources, :environments
4
+
5
+ def initialize(sources = {})
6
+ @sources = sources
7
+ @environments = %w(production)
8
+ end
9
+
10
+ def valid_env?
11
+ @environments.include?(ENV['RAILS_ENV'] || 'development')
12
+ end
13
+
14
+ def method_missing(m)
15
+ return unless @sources[m]
16
+ @sources[m]
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,35 @@
1
+ module FlowdockRails
2
+ class Flowdock
3
+ include FlowdockRails::Utils::Network
4
+
5
+ attr_reader :source
6
+
7
+ def initialize(source)
8
+ @source = source
9
+ @flow_token = FlowdockRails.configuration.send(source)
10
+ end
11
+
12
+ def ready?
13
+ !@flow_token.nil?
14
+ end
15
+
16
+ def post_message(message)
17
+ return unless FlowdockRails.configuration.valid_env?
18
+ raise 'Instance is not ready' unless ready?
19
+ params = format_params(message)
20
+ response = post('/messages', params)
21
+ message.thread_id = response.body['thread_id']
22
+ message.sent
23
+ message
24
+ end
25
+
26
+ private
27
+
28
+ def format_params(message)
29
+ {
30
+ thread_id: message.thread_id, content: message.text.to_s,
31
+ tags: message.format_tags, flow_token: @flow_token, event: 'message'
32
+ }.reject { |_, v| v.nil? }
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,35 @@
1
+ module FlowdockRails
2
+ # Create a message you can apply markdown to text multile line
3
+ # text
4
+ class Message
5
+ attr_accessor :thread_id, :text, :tags, :lines
6
+ def initialize(attributes = {})
7
+ @thread_id = attributes[:thread_id]
8
+ @text = attributes[:text]
9
+ @tags = attributes[:tags] || []
10
+ @lines = attributes[:lines] || []
11
+ @sent = false
12
+ end
13
+
14
+ def format_tags
15
+ @tags.map { |e| '#' + e.to_s }.join(',')
16
+ end
17
+
18
+ def thread?
19
+ !@thread_id.nil?
20
+ end
21
+
22
+ def sent?
23
+ @sent
24
+ end
25
+
26
+ def sent
27
+ @sent = true
28
+ end
29
+
30
+ def text
31
+ return lines.join("\n") if @lines.any?
32
+ @text
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,25 @@
1
+ require 'faraday_middleware'
2
+
3
+ module FlowdockRails
4
+ module Utils
5
+ module Network
6
+ def connection
7
+ @conn ||= Faraday.new(url: 'https://api.flowdock.com') do |conn|
8
+ conn.request :url_encoded
9
+ conn.response :logger
10
+ conn.response :json
11
+ conn.adapter Faraday.default_adapter
12
+ end
13
+ end
14
+
15
+ def post(url, params = {})
16
+ connection.post do |req|
17
+ req.url url
18
+ req.headers['Content-Type'] = 'application/json'
19
+ req.headers['X-flowdock-wait-for-message'] = 'true'
20
+ req.body = params.to_json
21
+ end
22
+ end
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,3 @@
1
+ module FlowdockRails
2
+ VERSION = "0.1.1"
3
+ end
@@ -0,0 +1,25 @@
1
+ require 'flowdock_rails/version'
2
+ require 'active_support'
3
+
4
+ module FlowdockRails
5
+ extend ActiveSupport::Autoload
6
+ autoload :Configuration
7
+
8
+ autoload_under 'models' do
9
+ autoload :Flowdock
10
+ autoload :Message
11
+ end
12
+
13
+ module Utils
14
+ extend ActiveSupport::Autoload
15
+ autoload :Network
16
+ end
17
+
18
+ def self.configure
19
+ yield configuration
20
+ end
21
+
22
+ def self.configuration
23
+ @configuration ||= Configuration.new
24
+ end
25
+ end
@@ -0,0 +1,12 @@
1
+ module FlowdockRails
2
+ module Generators # :nodoc:
3
+ class ConfigGenerator < Rails::Generators::Base # :nodoc:
4
+ source_root File.expand_path('../templates', __FILE__)
5
+ desc 'Install flowdock rails config'
6
+
7
+ def config
8
+ template 'config.rb', 'config/initializers/flowdock_rails.rb'
9
+ end
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,13 @@
1
+ require 'flowdock_rails'
2
+
3
+ FlowdockRails.configure do |config|
4
+ # You can configure more than one source.
5
+ # https://www.flowdock.com/api/sources
6
+ #
7
+ # config.sources = { main: 'token', bugs: 'token' }
8
+
9
+ # Configure env allowed to post messages
10
+ # default: production
11
+ #
12
+ # config.environments = %w(production)
13
+ end
metadata ADDED
@@ -0,0 +1,175 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: flowdock_rails
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - Oscar Rocha
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-08-10 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: faraday
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.9'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.9'
27
+ - !ruby/object:Gem::Dependency
28
+ name: faraday_middleware
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '0.10'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '0.10'
41
+ - !ruby/object:Gem::Dependency
42
+ name: activerecord
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '4.1'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '4.1'
55
+ - !ruby/object:Gem::Dependency
56
+ name: bundler
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.12'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.12'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rake
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '10.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '10.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '3.0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '3.0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: byebug
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '3.0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '3.0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: webmock
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ description: Connect flowdock using source feature from Rails
126
+ email:
127
+ - oscar_alan@hotmail.com
128
+ executables: []
129
+ extensions: []
130
+ extra_rdoc_files: []
131
+ files:
132
+ - ".gitignore"
133
+ - ".rspec"
134
+ - ".travis.yml"
135
+ - CODE_OF_CONDUCT.md
136
+ - Gemfile
137
+ - LICENSE.txt
138
+ - README.md
139
+ - Rakefile
140
+ - bin/console
141
+ - bin/setup
142
+ - flowdock_rails.gemspec
143
+ - lib/flowdock_rails.rb
144
+ - lib/flowdock_rails/configuration.rb
145
+ - lib/flowdock_rails/models/flowdock.rb
146
+ - lib/flowdock_rails/models/message.rb
147
+ - lib/flowdock_rails/utils/network.rb
148
+ - lib/flowdock_rails/version.rb
149
+ - lib/generators/flowdock_rails/config_generator.rb
150
+ - lib/generators/flowdock_rails/templates/config.rb
151
+ homepage: https://github.com/aaroalan
152
+ licenses:
153
+ - MIT
154
+ metadata: {}
155
+ post_install_message:
156
+ rdoc_options: []
157
+ require_paths:
158
+ - lib
159
+ required_ruby_version: !ruby/object:Gem::Requirement
160
+ requirements:
161
+ - - ">="
162
+ - !ruby/object:Gem::Version
163
+ version: '0'
164
+ required_rubygems_version: !ruby/object:Gem::Requirement
165
+ requirements:
166
+ - - ">="
167
+ - !ruby/object:Gem::Version
168
+ version: '0'
169
+ requirements: []
170
+ rubyforge_project:
171
+ rubygems_version: 2.5.1
172
+ signing_key:
173
+ specification_version: 4
174
+ summary: Flowdock connection
175
+ test_files: []