clubhouse_ruby 0.3.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fd8a31fc213799a4c32148450916cff148edac46
-  data.tar.gz: 2371dce1a6e09504a6880b6fb41f1f87825c28fc
+SHA256:
+  metadata.gz: 13cb0f9caf06ac43539370c7dfdd923f529957f5103fc302703bb62539f34cce
+  data.tar.gz: 98ae28e3b8901eb8e04c097f0d4594a1a9f76311cd15f5d0c068e768bed659da
 SHA512:
-  metadata.gz: dfbd67e65e330094531a4c7652e42e774557126b7bf486de3e37d285d4d75d6147c88ea725736030dd7cc8c73a2caa4ee23cd036022a3fcd6e3453ea426acd6e
-  data.tar.gz: 6666f1370c5b9491a172cf60fd8760dbd53658e7f4613b7fd2b6309a7b6f5809235a489c94f10161342f0f40f204d9f5d202b2ce596986aa566701463f5d586c
+  metadata.gz: c2c5adc1c0e876d8b06c1bbc6e4c0cb5eb04fe237a4eebc61e30a41406f5ff65fede491eb378e44284197c8e23c86d7165d5e31492920ef733b35456f9b536e1
+  data.tar.gz: 41246481a44cdd266054da35c31bd455a8746ef9e8b1aa819843ef2ce5e576e18eab42e9c15bd3420b38d77cf617c83deaa0f1de04268f959939b6bc2308349a

data/README.md

@@ -1,7 +1,7 @@
 # ClubhouseRuby
 
 ClubhouseRuby is a lightweight Ruby wrapper of the
-[Clubhouse REST API](https://clubhouse.io/api/rest/v2/).
+[Clubhouse REST API](https://clubhouse.io/api/rest/v3/).
 
 [Clubhouse](https://clubhouse.io) is a radical project management tool
 particularly well suited to software development. If you're not familiar with
@@ -41,10 +41,10 @@ operates as an effective turing machine when lubricated with oil.
 ## Usage
 
 This gem is a lightweight API wrapper. That means you'll need to refer to the
-[API documentation](https://clubhouse.io/api/rest/v2/) to figure out what resources
+[API documentation](https://clubhouse.io/api/rest/v3/) to figure out what resources
  and actions exist.
 
-On the plus side, once you know what you want to do, using this gem should be 
+On the plus side, once you know what you want to do, using this gem should be
 simple.
 
 Instantiate an object to interface with the API:
@@ -61,7 +61,7 @@ clubhouse = ClubhouseRuby::Clubhouse.new(<YOUR CLUBHOUSE API TOKEN>, response_fo
 
 Then, call methods on the object matching the resource(s) and action you are
 interested in. For example, if you want to list all available epics, you need to
-access the endpoint at https://api.clubhouse.io/api/v1/epics. The 
+access the endpoint at https://api.clubhouse.io/api/v1/epics. The
 clubhouse_ruby gem uses an explicit action:
 
 ```ruby
@@ -147,6 +147,28 @@ clubhouse.projects(<project_id>).stories.list
 # }
 ```
 
+You can search stories, using standard Clubhouse [search operators](https://help.clubhouse.io/hc/en-us/articles/360000046646-Search-Operators):
+
+```ruby
+clubhouse.search_stories(page_size: 25, query: 'state:500000016')
+# => {
+#   code: "200",
+#   status: "OK",
+#   content: {
+#     "next" => "/api/v3/search/stories?query=state%3A500000016&page_size=25&next=a8acc6577548df7a213272f7f9f617bcb1f8a831~24",
+#     "data" => [
+#       {
+#         "entity_type" => "story",
+#         "archived" => false,
+#         "created_at" => "...",
+#         "updated_at" => "...",
+#         ...
+#       }, ...
+#     ]
+#   }
+# }
+```
+
 You can build a path in steps rather than all at once, and execution is deferred
 until the action call:
 
@@ -234,9 +256,13 @@ clubhouse.projects.stories.list
 
 ## Version
 
-The currenet version of the clubhouse_ruby gem supports the current version of
-the API, version 2. If you want something that definitely works with v1, use
-version 0.2.0 of clubhouse_ruby.
+The current version of the clubhouse_ruby gem supports the current version of
+the API, version 3.
+
+If you want something that definitely works with:
+
+* v1, use version 0.2.0 of clubhouse_ruby
+* v2, use version 0.3.0 of clubhouse_ruby
 
 ## Development
 

data/clubhouse_ruby.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "dotenv", "~> 2.1"
-  spec.add_development_dependency "webmock", "~> 2.1"
-  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.7"
+  spec.add_development_dependency "vcr", "~> 6.0"
 end

data/lib/clubhouse_ruby/constants.rb

@@ -2,7 +2,7 @@ require 'json'
 require 'csv'
 
 module ClubhouseRuby
-  API_URL = "https://api.clubhouse.io/api/v2/".freeze
+  API_URL = "https://api.clubhouse.io/api/v3/".freeze
 
   # Response formats the clubhouse api knows about
   FORMATS = {
@@ -28,8 +28,10 @@ module ClubhouseRuby
   # These are the resource for the clubhouse api and can form part of the path
   RESOURCES = [
     :categories,
+    :entity_templates,
     :epics,
     :files,
+    :iterations,
     :labels,
     :linked_files,
     :members,
@@ -39,7 +41,9 @@ module ClubhouseRuby
     :stories,
     :story_links,
     :teams,
-    :workflows
+    :workflows,
+    :tasks,
+    :comments
   ].freeze
 
   # These are the annoying edge cases in the clubhouse api that are don't fit
@@ -51,6 +55,10 @@ module ClubhouseRuby
     bulk_update: {
       path: :bulk,
       action: :Put
+    },
+    search_stories: {
+      path: 'search/stories',
+      action: :Get
     }
   }.freeze
 end

data/lib/clubhouse_ruby/path_builder.rb

@@ -16,7 +16,7 @@ module ClubhouseRuby
     #
     # This example will execute a call to:
     #
-    # `https://api.clubhouse.io/api/v2/stories/{story-id}/comments/{comment-id}`
+    # `https://api.clubhouse.io/api/v3/stories/{story-id}/comments/{comment-id}`
     #
     # with arguments:
     #

data/lib/clubhouse_ruby/version.rb

@@ -1,3 +1,3 @@
 module ClubhouseRuby
-  VERSION = "0.3.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clubhouse_ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Philip Castiglione
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-28 00:00:00.000000000 Z
+date: 2020-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
 description: 
 email:
 - philipcastiglione@gmail.com
@@ -135,8 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A lightweight Ruby wrapper for the Clubhouse REST API.