clubhouse_ruby 0.2.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 99130661e8bef360cc89dc809b212764a013ed45
-  data.tar.gz: 398600d53686e920fb38f95cd54955b000af0006
+SHA256:
+  metadata.gz: 9d693312a99038c0ef59878c1eb02bac7357823f741f1b6fd19219352bcff92b
+  data.tar.gz: 0b608b34ae934a6e82ed82321f99ce9f56132b42e4f6392f686dc84a55c95dc5
 SHA512:
-  metadata.gz: 2dcdc681c343e90ecebc0def690f3307d607ecf1ca38806aa696b2e4882a6801e869021682fde9ce656bacec5097dda58069ec63ef803c659a642751508afb0d
-  data.tar.gz: 5502abcfcd208946601679d9125e2789b0645b22c104c688936d90aacb3a00cabb7c1558a82207a335cd38debcf048bf5330b22ac6ec82694f76add07d4e5eff
+  metadata.gz: 7b96dcef0e588c302bc889792e630671a65f24508e98e975a07ee9c5e58c4d82a2174b0f2ac15c55119ebe1fc76317d26ff0a710068e42e6ec095ad2c2d44935
+  data.tar.gz: a1713087da50913a4e8eb414b39d68590673ca594bffeb029172638d804a3fdd2f9a665e71db6ff6e91f5e691e86c10b01fa5f3165a88a1c36f0654857303a60

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Philip Castiglione
+Copyright (c) 2017 Philip Castiglione
 
 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 API](https://clubhouse.io/api/v1/).
+[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
@@ -30,7 +30,7 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it globally:
 
     $ gem install clubhouse_ruby
 
@@ -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/v1/) 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
@@ -70,21 +70,33 @@ clubhouse.epics.list
 #   code: "200",
 #   status: "OK",
 #   content: [
-#     {
-#       "id" => 1,
-#       "name" => "An Odyssian Epic",
-#       "description" => "Outrageously epic.",
-#       "created_at" => "...",
-#       "updated_at" => "...",
-#       "deadline "=> nil,
-#       "state" => "to do",
-#       "position" => 1,
-#       "archived" => false,
-#       "follower_ids" => [...],
-#       "owner_ids" => [...],
-#       "comments" => [...]
-#      }
-#    ]
+#    {
+#      "entity_type" => "epic",
+#      "id" => 1,
+#      "external_id" => nil,
+#      "name" => "An Odyssian Epic",
+#      "description" => "Outrageously epic.",
+#      "created_at" => "...",
+#      "updated_at" => "...",
+#      "deadline "=> nil,
+#      "state" => "to do",
+#      "position" => 1,
+#      "started" => false,
+#      "started_at" => nil,
+#      "started_at_override" => nil,
+#      "completed" => false,
+#      "completed_at" => nil,
+#      "completed_at_override" => nil,
+#      "archived" => false,
+#      "labels" => [...],
+#      "milestone_id" => nil,
+#      "follower_ids" => [...],
+#      "owner_ids" => [...],
+#      "project_ids" => [...],
+#      "comments" => [...],
+#      "stats" => {...},
+#     }, ...
+#   ]
 # }
 ```
 
@@ -97,18 +109,12 @@ clubhouse.epics.create(name: "My New Epic", state: "to do")
 #   code: "201",
 #   status: "Created",
 #   content: {
+#     "entity_type" => "epic",
 #     "id" => 2,
+#     "extenal_id" => nil,
 #     "name" => "My New Epic",
 #     "description" => "",
-#     "created_at" => "...",
-#     "updated_at" => "...",
-#     "deadline" => nil,
-#     "state" => "to do",
-#     "position" => 2,
-#     "archived" => false,
-#     "follower_ids" => [],
-#     "owner_ids" => [],
-#     "comments" => []
+#     ...
 #   }
 # }
 ```
@@ -125,42 +131,44 @@ clubhouse.projects(<project_id>).stories.list
 #   status: "OK",
 #   content: [
 #     {
+#       "entity_type" => "story",
 #       "archived" => false,
 #       "created_at" => "...",
+#       "updated_at" => "...",
 #       "id" => 1,
+#       "external_id" => nil,
 #       "name" => "Rescue Prince",
 #       "story_type" => "feature",
 #       "description" => "The prince is trapped in a tower and needs freeing.",
 #       "position" => 1,
-#       "workflow_state_id" => "...",
-#       "estimate" => 0,
-#       "updated_at" => "...",
-#       "deadline" => nil,
-#       "project_id" => <project_id>,
-#       "labels" => [
-#         {
-#           "id" => "...",
-#           "name" => "Urgent",
-#           "created_at" => "...",
-#           "updated_at" => "..."
-#         }
-#       ],
-#       "requested_by_id" => "...",
-#       "owner_ids" => [...],
-#       "follower_ids" => [...],
-#       "epic_id" => "...",
-#       "file_ids" => [...],
-#       "linked_file_ids" => [...],
-#       "comments" => [...],
-#       "tasks" => [...],
-#       "story_links" => [...]
-#     },
-#     {...},
-#     {...}
+#       ...
+#     }, ...
 #   ]
 # }
 ```
 
+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:
 
@@ -209,21 +217,21 @@ clubhouse.epics.list
 ```
 
 Arbitrary combinations of resources not building a path that matches a url the
-API knows about will fail. Note the clubhouse API gives little away, returning
-forbidden:
+API knows about will fail.
 
 ```ruby
 clubhouse.epics(epic_id).stories.list
 # => {
-#   code: "403",
-#   status: "Forbidden",
+#   code: "404",
+#   status: "Not Found",
 #   content: {
-#     "message" => "Sorry, you do not have access to this resource.",
-#     "tag" => "user_denied_access"
+#     "message" => "Page not Found"
 #   }
 # }
 ```
 
+Note: the v1 API returns forbidden rather than not found.
+
 Attempting to access a nested resource without providing the parent id as an
 argument is a bad request:
 
@@ -246,6 +254,16 @@ clubhouse.projects.stories.list
 # }
 ```
 
+## Version
+
+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
 
 After checking out the repo, run `bin/setup` to install dependencies and

data/clubhouse_ruby.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Philip Castiglione"]
   spec.email         = ["philipcastiglione@gmail.com"]
 
-  spec.summary       = %q{A lightweight ruby wrapper for the Clubhouse API: https://clubhouse.io/api/v1}
+  spec.summary       = %q{A lightweight Ruby wrapper for the Clubhouse REST API.}
   spec.homepage      = "https://github.com/PhilipCastiglione/clubhouse_ruby"
   spec.license       = "MIT"
 
@@ -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/v1/".freeze
+  API_URL = "https://api.clubhouse.io/api/v3/".freeze
 
   # Response formats the clubhouse api knows about
   FORMATS = {
@@ -27,25 +27,26 @@ module ClubhouseRuby
 
   # These are the resource for the clubhouse api and can form part of the path
   RESOURCES = [
+    :categories,
     :epics,
     :files,
+    :iterations,
     :labels,
     :linked_files,
+    :members,
+    :milestones,
     :projects,
-    :story_links,
+    :repositories,
     :stories,
+    :story_links,
+    :teams,
+    :workflows,
     :tasks,
-    :comments,
-    :users,
-    :workflows
+    :comments
   ].freeze
 
   # These are the annoying edge cases in the clubhouse api that are don't fit
   EXCEPTIONS = {
-    search: {
-      path: :search,
-      action: :Post
-    },
     bulk_create: {
       path: :bulk,
       action: :Post
@@ -53,6 +54,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/v1/stories/{story-id}/comments/{comment-id}`
+    # `https://api.clubhouse.io/api/v3/stories/{story-id}/comments/{comment-id}`
     #
     # with arguments:
     #
@@ -50,9 +50,9 @@ module ClubhouseRuby
     # We'd better not lie when asked.
     #
     def respond_to_missing?(name, include_private = false)
-      ACTIONS.keys.include?(name) ||
-        RESOURCES.include?(name) ||
-        EXCEPTIONS.keys.include?(name) ||
+      known_action?(name) ||
+        known_resource?(name) ||
+        known_exception?(name) ||
         super
     end
 

data/lib/clubhouse_ruby/version.rb

@@ -1,3 +1,3 @@
 module ClubhouseRuby
-  VERSION = "0.2.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clubhouse_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Philip Castiglione
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-25 00:00:00.000000000 Z
+date: 2020-10-08 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,9 +135,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: 'A lightweight ruby wrapper for the Clubhouse API: https://clubhouse.io/api/v1'
+summary: A lightweight Ruby wrapper for the Clubhouse REST API.
 test_files: []