tempo-ruby 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.
data/Gemfile.lock ADDED
@@ -0,0 +1,137 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ tempo-ruby (0.1.0)
5
+ activesupport (~> 6.1.4.1)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ activesupport (6.1.4.1)
11
+ concurrent-ruby (~> 1.0, >= 1.0.2)
12
+ i18n (>= 1.6, < 2)
13
+ minitest (>= 5.1)
14
+ tzinfo (~> 2.0)
15
+ zeitwerk (~> 2.3)
16
+ addressable (2.8.0)
17
+ public_suffix (>= 2.0.2, < 5.0)
18
+ ast (2.4.2)
19
+ bundler-audit (0.9.0.1)
20
+ bundler (>= 1.2.0, < 3)
21
+ thor (~> 1.0)
22
+ byebug (11.1.3)
23
+ childprocess (4.1.0)
24
+ coderay (1.1.3)
25
+ colorize (0.8.1)
26
+ concurrent-ruby (1.1.9)
27
+ crack (0.4.5)
28
+ rexml
29
+ diff-lcs (1.5.0)
30
+ docile (1.4.0)
31
+ fasterer (0.9.0)
32
+ colorize (~> 0.7)
33
+ ruby_parser (>= 3.14.1)
34
+ ffaker (2.20.0)
35
+ hashdiff (1.0.1)
36
+ i18n (1.8.11)
37
+ concurrent-ruby (~> 1.0)
38
+ iniparse (1.5.0)
39
+ json (2.6.1)
40
+ kwalify (0.7.2)
41
+ method_source (1.0.0)
42
+ minitest (5.14.4)
43
+ overcommit (0.58.0)
44
+ childprocess (>= 0.6.3, < 5)
45
+ iniparse (~> 1.4)
46
+ rexml (~> 3.2)
47
+ parallel (1.21.0)
48
+ parser (3.1.0.0)
49
+ ast (~> 2.4.1)
50
+ pry (0.13.1)
51
+ coderay (~> 1.1)
52
+ method_source (~> 1.0)
53
+ pry-byebug (3.9.0)
54
+ byebug (~> 11.0)
55
+ pry (~> 0.13.0)
56
+ public_suffix (4.0.6)
57
+ rainbow (3.1.1)
58
+ rake (13.0.6)
59
+ reek (6.1.0)
60
+ kwalify (~> 0.7.0)
61
+ parser (~> 3.1.0)
62
+ rainbow (>= 2.0, < 4.0)
63
+ regexp_parser (2.2.0)
64
+ rexml (3.2.5)
65
+ rspec (3.10.0)
66
+ rspec-core (~> 3.10.0)
67
+ rspec-expectations (~> 3.10.0)
68
+ rspec-mocks (~> 3.10.0)
69
+ rspec-core (3.10.1)
70
+ rspec-support (~> 3.10.0)
71
+ rspec-expectations (3.10.2)
72
+ diff-lcs (>= 1.2.0, < 2.0)
73
+ rspec-support (~> 3.10.0)
74
+ rspec-mocks (3.10.2)
75
+ diff-lcs (>= 1.2.0, < 2.0)
76
+ rspec-support (~> 3.10.0)
77
+ rspec-support (3.10.3)
78
+ rubocop (1.25.0)
79
+ parallel (~> 1.10)
80
+ parser (>= 3.1.0.0)
81
+ rainbow (>= 2.2.2, < 4.0)
82
+ regexp_parser (>= 1.8, < 3.0)
83
+ rexml
84
+ rubocop-ast (>= 1.15.1, < 2.0)
85
+ ruby-progressbar (~> 1.7)
86
+ unicode-display_width (>= 1.4.0, < 3.0)
87
+ rubocop-ast (1.15.1)
88
+ parser (>= 3.0.1.1)
89
+ rubocop-performance (1.13.2)
90
+ rubocop (>= 1.7.0, < 2.0)
91
+ rubocop-ast (>= 0.4.0)
92
+ rubocop-rake (0.6.0)
93
+ rubocop (~> 1.0)
94
+ rubocop-rspec (2.7.0)
95
+ rubocop (~> 1.19)
96
+ ruby-progressbar (1.11.0)
97
+ ruby_parser (3.18.1)
98
+ sexp_processor (~> 4.16)
99
+ sexp_processor (4.16.0)
100
+ simplecov (0.17.1)
101
+ docile (~> 1.1)
102
+ json (>= 1.8, < 3)
103
+ simplecov-html (~> 0.10.0)
104
+ simplecov-html (0.10.2)
105
+ thor (1.2.1)
106
+ tzinfo (2.0.4)
107
+ concurrent-ruby (~> 1.0)
108
+ unicode-display_width (2.1.0)
109
+ webmock (3.12.2)
110
+ addressable (>= 2.3.6)
111
+ crack (>= 0.3.2)
112
+ hashdiff (>= 0.4.0, < 2.0.0)
113
+ zeitwerk (2.5.1)
114
+
115
+ PLATFORMS
116
+ arm64-darwin-21
117
+ x86_64-darwin-18
118
+
119
+ DEPENDENCIES
120
+ bundler-audit (~> 0.9.0.1)
121
+ fasterer (~> 0.9.0)
122
+ ffaker (~> 2.20)
123
+ overcommit (~> 0.58.0)
124
+ pry-byebug (~> 3.9)
125
+ rake (~> 13.0, >= 13.0.6)
126
+ reek (~> 6.0, >= 6.0.6)
127
+ rspec (~> 3.10)
128
+ rubocop (~> 1.24)
129
+ rubocop-performance (~> 1.13)
130
+ rubocop-rake (~> 0.6.0)
131
+ rubocop-rspec (~> 2.7)
132
+ simplecov (~> 0.17.1)
133
+ tempo-ruby!
134
+ webmock (~> 3.12.2)
135
+
136
+ BUNDLED WITH
137
+ 2.2.16
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2022 TODO: Write your name
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,85 @@
1
+ # ![tempo-ruby - 💎 Ruby gem for the 🕛 Tempo REST API :3](https://i.ibb.co/0f1pwBb/A4-1-4.png)
2
+
3
+ # Tempo API Gem
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'tempo-ruby'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle install
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install tempo-ruby
22
+
23
+ ## Usage
24
+
25
+ ### Example
26
+
27
+ ```ruby
28
+ require 'rubygems'
29
+ require 'tempo-ruby'
30
+
31
+ options = {
32
+ auth_type: :api_key,
33
+ api_key: 'your_tempo_api_key'
34
+ }
35
+
36
+ client = Tempo::Client.new(options)
37
+ teams = client.Team.all
38
+ team_members = teams.first.members
39
+ ```
40
+
41
+ #### Configuration options
42
+
43
+ TODO: Document options
44
+
45
+ #### More Examples
46
+
47
+ TODO: More examples with more CRUDs
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
+ 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
54
+
55
+ ## Roadmap
56
+
57
+ #### Version 0.1.0
58
+ - [x] Ability to use API key
59
+ - [x] README file with example
60
+
61
+ #### Version 0.2.0
62
+ - [ ] Base read CRUD(for another mine project)
63
+ - [ ] Full Teams CRUD
64
+ - [ ] Well documented README file
65
+
66
+ #### Refactoring
67
+ - [ ] Enabled disabled fasterer checks
68
+ - [ ] Refactor Tempo::Base class
69
+ - [ ] Enabled reek checks
70
+ - [ ] Enable disabled rubocop checks
71
+ - [ ] Increase specs coverage
72
+ - [ ] Clean project from unused functionality
73
+
74
+
75
+ ## Contributing
76
+
77
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tempo-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/tempo-ruby/blob/main/CODE_OF_CONDUCT.md).
78
+
79
+ ## License
80
+
81
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
82
+
83
+ ## Code of Conduct
84
+
85
+ Everyone interacting in the Tempo API Client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tempo-ruby/blob/main/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'bundler/gem_tasks'
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ require 'rubocop/rake_task'
9
+
10
+ RuboCop::RakeTask.new
11
+
12
+ task default: %i[spec rubocop]
data/bin/console ADDED
@@ -0,0 +1,15 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require 'bundler/setup'
5
+ require 'tempo_ruby'
6
+
7
+ # You can add fixtures and/or initialization code here to make experimenting
8
+ # with your gem easier. You can also use a different console, if you like.
9
+
10
+ # (If you use this, don't forget to add pry to your Gemfile!)
11
+ # require "pry"
12
+ # Pry.start
13
+
14
+ require 'irb'
15
+ IRB.start(__FILE__)
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