clubhouse_ruby 0.4.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 73fb9602e9ee8f5a3d249ee5cf582b854dca1501
-  data.tar.gz: b744eb45c3bcc29b6c3b927e76703efa6d302894
+SHA256:
+  metadata.gz: 45522d24c367a84e7e275c02608bebb005817a4d72273378be276a829e821450
+  data.tar.gz: 25d17170885a8b17586b5a65a66b13367a1cdd16801f32d268b6b7ce5358e85a
 SHA512:
-  metadata.gz: b4875de365b95adadab6a24f05e4f8f2605d8d3b15b1dae7e8b56aea34370ec1d22f615a1e7a415e1fdef17770c75f47d4c97eb78e7f1137f9c615f4577ef8ed
-  data.tar.gz: 70b9fb7d0376a135c6d5b4a991f9b78756343f0538a9de60490f4c0025e8a8884abf570a3c931ead7ed052a209bb7f4db0b9c5d2967e2a951ab0d63af3242e6a
+  metadata.gz: 3e975109f0422f5cc0360706d3fc7dad7dcb6b4bb27a55153b38bac8f167d5e3f0f84cc0dd191aae21f8c64f791cccfd5828bad9cf3b37a5fa96911ea3a835e3
+  data.tar.gz: 59c2e807d9e41a6b7a5bd05c9f7fa1afc76fc4ec56851ee8885ceafd9010a035bf76989379dc433de691d715bb83f882164ece6960cd90f354de11baeb198133

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Philip Castiglione
+Copyright (c) 2021 Jake Sorce
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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
- and actions exist.
+[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:
 
@@ -174,7 +196,7 @@ accessing nested resources) followed by a final action that matches the methods
 in the Clubhouse API documentation.
 
 These resources and methods are enumerated in the source code
-[here](https://github.com/PhilipCastiglione/clubhouse_ruby/blob/master/lib/clubhouse_ruby/constants.rb)
+[here](https://github.com/jakesorce/clubhouse_ruby/blob/master/lib/clubhouse_ruby/constants.rb)
 but generally you should find the url you are interested in from the docs.
 
 ## Errors
@@ -235,8 +257,12 @@ clubhouse.projects.stories.list
 ## Version
 
 The current 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 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
 
@@ -262,7 +288,7 @@ will be in publically visible from the code in this repo.**
 ## Contributing
 
 Bug reports and pull requests are entirely welcome on GitHub at
-https://github.com/philipcastiglione/clubhouse_ruby.
+https://github.com/jakesorce/clubhouse_ruby.
 
 ## License
 

data/clubhouse_ruby.gemspec

@@ -1,16 +1,15 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'clubhouse_ruby/version'
+require "clubhouse_ruby/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "clubhouse_ruby"
   spec.version       = ClubhouseRuby::VERSION
-  spec.authors       = ["Philip Castiglione"]
-  spec.email         = ["philipcastiglione@gmail.com"]
+  spec.authors       = ["Jake Sorce"]
+  spec.email         = ["jakesorce@gmail.com"]
 
-  spec.summary       = %q{A lightweight Ruby wrapper for the Clubhouse REST API.}
-  spec.homepage      = "https://github.com/PhilipCastiglione/clubhouse_ruby"
+  spec.summary       = "A lightweight Ruby wrapper for the Clubhouse REST API."
+  spec.homepage      = "https://github.com/jakesorce/clubhouse_ruby"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -18,10 +17,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 "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 2.1"
   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 "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 6.0"
+  spec.add_development_dependency "webmock", "~> 3.7"
 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,10 +28,13 @@ 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,
+    :member,
     :members,
     :milestones,
     :projects,
@@ -41,7 +44,8 @@ module ClubhouseRuby
     :teams,
     :workflows,
     :tasks,
-    :comments
+    :comments,
+    :groups
   ].freeze
 
   # These are the annoying edge cases in the clubhouse api that are don't fit
@@ -53,6 +57,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.4.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clubhouse_ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.10.0
 platform: ruby
 authors:
-- Philip Castiglione
+- Jake Sorce
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-04 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,87 +16,87 @@ 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
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
 description: 
 email:
-- philipcastiglione@gmail.com
+- jakesorce@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -116,7 +116,7 @@ files:
 - lib/clubhouse_ruby/path_builder.rb
 - lib/clubhouse_ruby/request.rb
 - lib/clubhouse_ruby/version.rb
-homepage: https://github.com/PhilipCastiglione/clubhouse_ruby
+homepage: https://github.com/jakesorce/clubhouse_ruby
 licenses:
 - MIT
 metadata: {}
@@ -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.1.4
 signing_key: 
 specification_version: 4
 summary: A lightweight Ruby wrapper for the Clubhouse REST API.