obeya 0.1.0

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: 22b1e139ffc2d08751922cfa5e1b0e6109f40ca5
4
+ data.tar.gz: 1fea464b707b6589b01d4e84d78d7fe846ee61df
5
+ SHA512:
6
+ metadata.gz: bbf64ea647f26fe67b1c31165317c7041006c465f00d985aaa15993f1c4af854375685343a29aff9bdba3f6f14db7396bef9e544aaf7805871ac4e1fdc8c66c1
7
+ data.tar.gz: 51b8cc2d62462e2c050a8020f0d40e9d909f33e15014c42090b45e133c041c87fa9eaee244442f0c9b8421544a628fff346ce3689232ce84d0df029a581ee13c
data/.gitignore ADDED
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ .ruby-version
11
+ .ruby-gemset
12
+ /_ignore
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.0
5
+ before_install: gem install bundler -v 1.12.5
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ # CHANGELOG
2
+
3
+ ## 0.1.0 (not yet released)
4
+
5
+ * initial copy from the `investapp`
@@ -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 boettger@mt7.de. 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 obeya.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Thorsten Böttger
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,40 @@
1
+ # Obeya
2
+
3
+ The `obeya` gem provides a wrapper around the
4
+ [Obeya API](https://beta.getobeya.com/public/rest-help.html)
5
+
6
+ ## Installation
7
+
8
+ Add this line to your application's Gemfile:
9
+
10
+ ```ruby
11
+ gem 'obeya'
12
+ ```
13
+
14
+ And then execute:
15
+
16
+ $ bundle
17
+
18
+ Or install it yourself as:
19
+
20
+ $ gem install obeya
21
+
22
+ ## Usage
23
+
24
+ TODO: Write usage instructions here
25
+
26
+ ## Development
27
+
28
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
29
+
30
+ 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).
31
+
32
+ ## Contributing
33
+
34
+ Bug reports and pull requests are welcome on GitHub at https://github.com/sharesight/obeya. 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.
35
+
36
+
37
+ ## License
38
+
39
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
40
+
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "obeya"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/lib/obeya/bin.rb ADDED
@@ -0,0 +1,12 @@
1
+ module Obeya
2
+ class Bin
3
+
4
+ attr_reader :id, :name
5
+
6
+ def initialize(id, name)
7
+ @id = id
8
+ @name = name
9
+ end
10
+
11
+ end
12
+ end
@@ -0,0 +1,99 @@
1
+ require 'faraday'
2
+ require 'faraday_middleware'
3
+
4
+ module Obeya
5
+ class Client
6
+
7
+ OBEYA_ROOT_URL = "https://beta.getobeya.com"
8
+
9
+ def initialize(company_id, username, password)
10
+ @company_id = company_id
11
+ @username = username
12
+ @password = password
13
+ end
14
+
15
+ def create_ticket(title, description, format: 'text', ticket_type_name: 'Bug', bin_name: /please panic/i)
16
+ ticket = Ticket.new(
17
+ title,
18
+ description,
19
+ format,
20
+ ticket_type(ticket_type_name),
21
+ bin(bin_name)
22
+ )
23
+
24
+ response = post("/tickets/#{next_ticket_id}", ticket.to_json)
25
+ case response.status
26
+ when 200..299
27
+ true
28
+ else
29
+ puts "status: #{response.status}"
30
+ puts " #{response.inspect}"
31
+ false
32
+ end
33
+ end
34
+
35
+ def bin(name_or_regex)
36
+ case name_or_regex
37
+ when String
38
+ bins.detect { |bin| bin.name == name_or_regex }
39
+ when Regexp
40
+ bins.detect { |bin| bin.name =~ name_or_regex }
41
+ end
42
+ end
43
+
44
+ def bins
45
+ @bins ||= begin
46
+ get('/bins').map do |bin_data|
47
+ Bin.new(bin_data['_id'], bin_data['name'])
48
+ end
49
+ end
50
+ end
51
+
52
+ def ticket_type(name_or_regex)
53
+ case name_or_regex
54
+ when String
55
+ ticket_types.detect { |tt| tt.name == name_or_regex }
56
+ when Regexp
57
+ ticket_types.detect { |tt| tt.name =~ name_or_regex }
58
+ end
59
+ end
60
+
61
+ def ticket_types
62
+ @ticket_types ||= begin
63
+ get('/ticket-types').map do |bin_data|
64
+ TicketType.new(bin_data['_id'], bin_data['name'])
65
+ end
66
+ end
67
+ end
68
+
69
+ private
70
+
71
+ def next_ticket_id
72
+ get('/ids?amount=1')[0]
73
+ end
74
+
75
+ def get(api_path)
76
+ response = faraday.get("/rest/1/#{@company_id}#{api_path}") do |request|
77
+ request.headers.update({ accept: 'application/json', content_type: 'application/json' })
78
+ end
79
+ unless response.success?
80
+ raise("Obeya #{api_path} call failsed")
81
+ end
82
+ JSON.parse(response.body)
83
+ end
84
+
85
+ def post(api_path, json)
86
+ faraday.post("/rest/1/#{@company_id}#{api_path}", json) do |request|
87
+ request.headers.update({ accept: 'application/json', content_type: 'application/json' })
88
+ end
89
+ end
90
+
91
+ def faraday
92
+ @faraday ||= Faraday.new(OBEYA_ROOT_URL).tap do |connection|
93
+ connection.basic_auth(@username, @password)
94
+ connection.request(:json)
95
+ end
96
+ end
97
+
98
+ end
99
+ end
@@ -0,0 +1,29 @@
1
+ module Obeya
2
+ class Ticket
3
+
4
+ def initialize(title, description, format, ticket_type, bin)
5
+ @title = title
6
+ @description = description
7
+ @format = format
8
+ @ticket_type = ticket_type
9
+ @bin = bin
10
+ end
11
+
12
+ def to_json
13
+ {
14
+ "name": @title,
15
+ "rtformat": @format,
16
+ "description": normalise(@description),
17
+ "bin_id": @bin.id,
18
+ "ticketType_id": @ticket_type.id
19
+ }.to_json
20
+ end
21
+
22
+ private
23
+
24
+ def normalise(text)
25
+ text.length > 40_000 ? (text[0...39_950] + '...[truncated]') : text
26
+ end
27
+
28
+ end
29
+ end
@@ -0,0 +1,12 @@
1
+ module Obeya
2
+ class TicketType
3
+
4
+ attr_reader :id, :name
5
+
6
+ def initialize(id, name)
7
+ @id = id
8
+ @name = name
9
+ end
10
+
11
+ end
12
+ end
@@ -0,0 +1,3 @@
1
+ module Obeya
2
+ VERSION = "0.1.0"
3
+ end
data/lib/obeya.rb ADDED
@@ -0,0 +1,9 @@
1
+ require "obeya/version"
2
+ require "obeya/bin"
3
+ require "obeya/ticket_type"
4
+ require "obeya/ticket"
5
+ require "obeya/client"
6
+
7
+ module Obeya
8
+ # Your code goes here...
9
+ end
data/obeya.gemspec ADDED
@@ -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 'obeya/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "obeya"
8
+ spec.version = Obeya::VERSION
9
+ spec.authors = ["Thorsten Boettger"]
10
+ spec.email = ["boettger@mt7.de"]
11
+
12
+ spec.summary = %q{Wrapper for the Obeya API}
13
+ spec.description = %q{Wrapper for the Obeya API}
14
+ spec.homepage = "https://github.com/sharesight/obeya"
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_dependency "faraday"
23
+ spec.add_dependency "faraday_middleware"
24
+
25
+ spec.add_development_dependency "bundler", "~> 1.12"
26
+ spec.add_development_dependency "rake", "~> 10.0"
27
+ spec.add_development_dependency "pry"
28
+ spec.add_development_dependency "maxitest", '~> 1'
29
+ spec.add_development_dependency "shoulda-context"
30
+ spec.add_development_dependency "webmock"
31
+ end
metadata ADDED
@@ -0,0 +1,173 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: obeya
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Thorsten Boettger
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-09-07 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'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
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'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.12'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.12'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: pry
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: maxitest
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '1'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '1'
97
+ - !ruby/object:Gem::Dependency
98
+ name: shoulda-context
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '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: Wrapper for the Obeya API
126
+ email:
127
+ - boettger@mt7.de
128
+ executables: []
129
+ extensions: []
130
+ extra_rdoc_files: []
131
+ files:
132
+ - ".gitignore"
133
+ - ".travis.yml"
134
+ - CHANGELOG.md
135
+ - CODE_OF_CONDUCT.md
136
+ - Gemfile
137
+ - LICENSE.txt
138
+ - README.md
139
+ - Rakefile
140
+ - bin/console
141
+ - bin/setup
142
+ - lib/obeya.rb
143
+ - lib/obeya/bin.rb
144
+ - lib/obeya/client.rb
145
+ - lib/obeya/ticket.rb
146
+ - lib/obeya/ticket_type.rb
147
+ - lib/obeya/version.rb
148
+ - obeya.gemspec
149
+ homepage: https://github.com/sharesight/obeya
150
+ licenses:
151
+ - MIT
152
+ metadata: {}
153
+ post_install_message:
154
+ rdoc_options: []
155
+ require_paths:
156
+ - lib
157
+ required_ruby_version: !ruby/object:Gem::Requirement
158
+ requirements:
159
+ - - ">="
160
+ - !ruby/object:Gem::Version
161
+ version: '0'
162
+ required_rubygems_version: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - ">="
165
+ - !ruby/object:Gem::Version
166
+ version: '0'
167
+ requirements: []
168
+ rubyforge_project:
169
+ rubygems_version: 2.5.1
170
+ signing_key:
171
+ specification_version: 4
172
+ summary: Wrapper for the Obeya API
173
+ test_files: []