clubhouse_ruby 0.4.0 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 73fb9602e9ee8f5a3d249ee5cf582b854dca1501
4
- data.tar.gz: b744eb45c3bcc29b6c3b927e76703efa6d302894
2
+ SHA256:
3
+ metadata.gz: 57c8c64743800f7664c5357fa7e83e0ff6a448e110543f718f5bd2519a145233
4
+ data.tar.gz: 7e6d7ce64063587ac62b4d2cc42abe09385c01777ce57671ed0cf544bbbf90e9
5
5
  SHA512:
6
- metadata.gz: b4875de365b95adadab6a24f05e4f8f2605d8d3b15b1dae7e8b56aea34370ec1d22f615a1e7a415e1fdef17770c75f47d4c97eb78e7f1137f9c615f4577ef8ed
7
- data.tar.gz: 70b9fb7d0376a135c6d5b4a991f9b78756343f0538a9de60490f4c0025e8a8884abf570a3c931ead7ed052a209bb7f4db0b9c5d2967e2a951ab0d63af3242e6a
6
+ metadata.gz: c4a172e9c655da2e4b0f5ec494419a72844677fab6d5d3c04b278af2c444aa1c7fc7989fed5576006bd7b9b5c41ffc272ecd511277e6fd822888301f5b5fc0b9
7
+ data.tar.gz: 821e42e8fa896f6f918d4a4bfd5a741f9a68fd2bc0225148bd0b05f474cae4fefd33908e026da95414d5038466c3076b9175b6bcf3e9152771c3db60917240f2
data/README.md CHANGED
@@ -44,7 +44,7 @@ This gem is a lightweight API wrapper. That means you'll need to refer to the
44
44
  [API documentation](https://clubhouse.io/api/rest/v2/) to figure out what resources
45
45
  and actions exist.
46
46
 
47
- On the plus side, once you know what you want to do, using this gem should be
47
+ On the plus side, once you know what you want to do, using this gem should be
48
48
  simple.
49
49
 
50
50
  Instantiate an object to interface with the API:
@@ -61,7 +61,7 @@ clubhouse = ClubhouseRuby::Clubhouse.new(<YOUR CLUBHOUSE API TOKEN>, response_fo
61
61
 
62
62
  Then, call methods on the object matching the resource(s) and action you are
63
63
  interested in. For example, if you want to list all available epics, you need to
64
- access the endpoint at https://api.clubhouse.io/api/v1/epics. The
64
+ access the endpoint at https://api.clubhouse.io/api/v1/epics. The
65
65
  clubhouse_ruby gem uses an explicit action:
66
66
 
67
67
  ```ruby
@@ -147,6 +147,28 @@ clubhouse.projects(<project_id>).stories.list
147
147
  # }
148
148
  ```
149
149
 
150
+ You can search stories, using standard Clubhouse [search operators](https://help.clubhouse.io/hc/en-us/articles/360000046646-Search-Operators):
151
+
152
+ ```ruby
153
+ clubhouse.search_stories(page_size: 25, query: 'state:500000016')
154
+ # => {
155
+ # code: "200",
156
+ # status: "OK",
157
+ # content: {
158
+ # "next" => "/api/v2/search/stories?query=state%3A500000016&page_size=25&next=a8acc6577548df7a213272f7f9f617bcb1f8a831~24",
159
+ # "data" => [
160
+ # {
161
+ # "entity_type" => "story",
162
+ # "archived" => false,
163
+ # "created_at" => "...",
164
+ # "updated_at" => "...",
165
+ # ...
166
+ # }, ...
167
+ # ]
168
+ # }
169
+ # }
170
+ ```
171
+
150
172
  You can build a path in steps rather than all at once, and execution is deferred
151
173
  until the action call:
152
174
 
@@ -53,6 +53,10 @@ module ClubhouseRuby
53
53
  bulk_update: {
54
54
  path: :bulk,
55
55
  action: :Put
56
+ },
57
+ search_stories: {
58
+ path: 'search/stories',
59
+ action: :Get
56
60
  }
57
61
  }.freeze
58
62
  end
@@ -1,3 +1,3 @@
1
1
  module ClubhouseRuby
2
- VERSION = "0.4.0"
2
+ VERSION = "0.5.0"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: clubhouse_ruby
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Philip Castiglione
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2018-02-04 00:00:00.000000000 Z
11
+ date: 2019-03-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -135,8 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
135
135
  - !ruby/object:Gem::Version
136
136
  version: '0'
137
137
  requirements: []
138
- rubyforge_project:
139
- rubygems_version: 2.6.8
138
+ rubygems_version: 3.0.1
140
139
  signing_key:
141
140
  specification_version: 4
142
141
  summary: A lightweight Ruby wrapper for the Clubhouse REST API.