clubhouse_ruby 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99130661e8bef360cc89dc809b212764a013ed45
+  data.tar.gz: 398600d53686e920fb38f95cd54955b000af0006
+SHA512:
+  metadata.gz: 2dcdc681c343e90ecebc0def690f3307d607ecf1ca38806aa696b2e4882a6801e869021682fde9ce656bacec5097dda58069ec63ef803c659a642751508afb0d
+  data.tar.gz: 5502abcfcd208946601679d9125e2789b0645b22c104c688936d90aacb3a00cabb7c1558a82207a335cd38debcf048bf5330b22ac6ec82694f76add07d4e5eff

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clubhouse_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,278 @@
+# ClubhouseRuby
+
+ClubhouseRuby is a lightweight Ruby wrapper of the
+[Clubhouse API](https://clubhouse.io/api/v1/).
+
+[Clubhouse](https://clubhouse.io) is a radical project management tool
+particularly well suited to software development. If you're not familiar with
+them, go check them out! :heart:
+
+This gem is built with the philosophy that a good API wrapper is a simpler
+alternative to a comprehensive client library and can provide a nice interface
+to the API using dynamic Ruby metaprogramming techniques rather than mapping
+functionality from the API to the library piece by piece.
+
+This enables the wrapper to be loosely coupled to the current implementation of
+the API, which makes it more resilient to change. Also, this approach takes much
+less code and maintenance effort, allowing the developer to be lazy. A
+reasonable person might fairly assume this to be the true rationale behind the
+philosophy. They'd be right.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clubhouse_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clubhouse_ruby
+
+Or transcribe the code by carving it character by character into the
+mechanically articulated hand built stone sculpture you've developed that
+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
+ and actions exist.
+
+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:
+
+```ruby
+clubhouse = ClubhouseRuby::Clubhouse.new(<YOUR CLUBHOUSE API TOKEN>)
+```
+
+The API can also provide responses in CSV format instead of the default JSON:
+
+```ruby
+clubhouse = ClubhouseRuby::Clubhouse.new(<YOUR CLUBHOUSE API TOKEN>, response_format: :csv)
+```
+
+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 
+clubhouse_ruby gem uses an explicit action:
+
+```ruby
+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" => [...]
+#      }
+#    ]
+# }
+```
+
+If the endpoint you want requires parameters, say if you wanted to create an
+epic, you provide a hash to the action call following the resource:
+
+```ruby
+clubhouse.epics.create(name: "My New Epic", state: "to do")
+# => {
+#   code: "201",
+#   status: "Created",
+#   content: {
+#     "id" => 2,
+#     "name" => "My New Epic",
+#     "description" => "",
+#     "created_at" => "...",
+#     "updated_at" => "...",
+#     "deadline" => nil,
+#     "state" => "to do",
+#     "position" => 2,
+#     "archived" => false,
+#     "follower_ids" => [],
+#     "owner_ids" => [],
+#     "comments" => []
+#   }
+# }
+```
+
+If the endpoint you want is nested, you can build a path by chaining method
+calls, providing any required parent resource id as an argument to that method
+in the chain. For example, if you wanted to list all the stories associated
+with a particular project:
+
+```ruby
+clubhouse.projects(<project_id>).stories.list
+# => {
+#   code: "200",
+#   status: "OK",
+#   content: [
+#     {
+#       "archived" => false,
+#       "created_at" => "...",
+#       "id" => 1,
+#       "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 build a path in steps rather than all at once, and execution is deferred
+until the action call:
+
+```ruby
+clubhouse.projects(<project_id>)
+clubhouse.stories
+clubhouse.list
+# => as above
+```
+
+If you are building a path and you make a mistake, you can clear the path:
+
+```ruby
+clubhouse.projects(project_id)
+clubhouse.epics
+clubhouse.clear_path
+# => []
+```
+
+You don't need to clear the path after a complete request, as that happens
+automatically.
+
+Note that the chained methods are always resources (with an id for a parent when
+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)
+but generally you should find the url you are interested in from the docs.
+
+## Errors
+
+Errors are passed through from the API relatively undecorated:
+
+```ruby
+clubhouse = ClubhouseRuby::Clubhouse.new("unrecognized token")
+clubhouse.epics.list
+# => {
+#   code: "401",
+#   status: "Unauthorized",
+#   content: {
+#     "message" => "Unauthorized",
+#     "tag" => "unauthorized"
+#   }
+# }
+```
+
+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:
+
+```ruby
+clubhouse.epics(epic_id).stories.list
+# => {
+#   code: "403",
+#   status: "Forbidden",
+#   content: {
+#     "message" => "Sorry, you do not have access to this resource.",
+#     "tag" => "user_denied_access"
+#   }
+# }
+```
+
+Attempting to access a nested resource without providing the parent id as an
+argument is a bad request:
+
+```ruby
+clubhouse.projects.stories.list
+# => {
+#   code: "400",
+#   status: "Bad Request",
+#   content: {
+#     "message" => "The request included invalid or missing parameters.",
+#     "errors" => {
+#       "project-public-id" => [
+#         "not", [
+#           "integer?",
+#           "projects"
+#         ]
+#       ]
+#     }
+#   }
+# }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies and
+following the instructions. Specifically, you can choose to provide a genuine
+Clubhouse API token in the `.env` file. This will be important if you want to
+use `bin/console` for an interactive prompt that allows you to experiment with
+the gem and real API responses.
+
+Use `rake spec` to run the tests. The tests don't make external requests but
+rather use VCR for stubbed responses. If you want to play with the tests and
+get real API responses (perhaps to extend the suite or for a new feature) then
+you'll need to have an API token in the env as described above.
+
+Note that the current test suite is far from exhaustive and could do with some
+love.
+
+**NB: If you have implemented a feature that requires a new cassette, make sure
+you change the uri referenced by the cassette you added to remove the API token
+if you have updated the environment to use your token. Otherwise your API token
+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.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clubhouse_ruby"
+require "dotenv"
+require "irb"
+
+Dotenv.load
+IRB.start

data/bin/setup

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+touch .env
+if [[ $(grep API_TOKEN .env) == "" ]]; then
+  echo "API_TOKEN=<YOUR CLUBHOUSE API TOKEN>" >> .env
+  echo ;
+  echo "DEVELOPER: Please edit .env to contain your clubhouse api token if you wish to use the console."
+  echo ;
+fi

data/clubhouse_ruby.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.summary       = %q{A lightweight ruby wrapper for the Clubhouse API: https://clubhouse.io/api/v1}
+  spec.homepage      = "https://github.com/PhilipCastiglione/clubhouse_ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  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 "dotenv", "~> 2.1"
+  spec.add_development_dependency "webmock", "~> 2.1"
+  spec.add_development_dependency "vcr", "~> 3.0"
+end

data/lib/clubhouse_ruby.rb

@@ -0,0 +1,28 @@
+require "clubhouse_ruby/version"
+require "clubhouse_ruby/constants"
+require "clubhouse_ruby/path_builder"
+require "clubhouse_ruby/request"
+
+module ClubhouseRuby
+  class Clubhouse
+    include PathBuilder
+
+    attr_accessor :token, :response_format
+
+    # This is the basic object to interact with the clubhouse api. An api token
+    # is required, and optionally the response format can be set.
+    #
+    def initialize(token, response_format: :json)
+      raise ArgumentError unless input_valid?(token, response_format)
+
+      self.token = token
+      self.response_format = response_format
+    end
+
+    private
+
+    def input_valid?(token, response_format)
+      !token.nil? && FORMATS.keys.include?(response_format)
+    end
+  end
+end

data/lib/clubhouse_ruby/constants.rb

@@ -0,0 +1,58 @@
+require 'json'
+require 'csv'
+
+module ClubhouseRuby
+  API_URL = "https://api.clubhouse.io/api/v1/".freeze
+
+  # Response formats the clubhouse api knows about
+  FORMATS = {
+    json: {
+      headers: { header: 'Content-Type', content: 'application/json' },
+      parser: JSON
+    },
+    csv: {
+      headers: { header: 'Accept', content: 'text/csv' },
+      parser: CSV
+    }
+  }.freeze
+
+  # Action words are nice for our internal api and match the api path too
+  ACTIONS = {
+    get: :Get,
+    update: :Put,
+    delete: :Delete,
+    list: :Get,
+    create: :Post
+  }.freeze
+
+  # These are the resource for the clubhouse api and can form part of the path
+  RESOURCES = [
+    :epics,
+    :files,
+    :labels,
+    :linked_files,
+    :projects,
+    :story_links,
+    :stories,
+    :tasks,
+    :comments,
+    :users,
+    :workflows
+  ].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
+    },
+    bulk_update: {
+      path: :bulk,
+      action: :Put
+    }
+  }.freeze
+end

data/lib/clubhouse_ruby/path_builder.rb

@@ -0,0 +1,90 @@
+module ClubhouseRuby
+  module PathBuilder
+    def self.included(_)
+      class_exec do
+        attr_accessor :path
+      end
+    end
+
+    # Uh oh! This will allow the class including this module to "build a path"
+    # by chaining calls to resources, terminated with a method linked to an
+    # action that will execute the api call.
+    #
+    # For example:
+    #
+    # `foo.stories(story_id).comments.update(id: comment_id, text: "comment text")`
+    #
+    # This example will execute a call to:
+    #
+    # `https://api.clubhouse.io/api/v1/stories/{story-id}/comments/{comment-id}`
+    #
+    # with arguments:
+    #
+    #   `{ text: "comment text" }`
+    #
+    def method_missing(name, *args)
+      if known_action?(name)
+        execute_request(ACTIONS[name], args.first)
+      elsif known_resource?(name)
+        build_path(name, args.first)
+      elsif known_exception?(name)
+        build_path(EXCEPTIONS[name][:path], nil)
+        execute_request(EXCEPTIONS[name][:action], args.first)
+      else
+        super
+      end
+    end
+
+    # You can build a path without executing in stages like this:
+    #
+    # `foo.stories(story_id)`
+    #
+    # This will partly populate foo:path, but won't execute the call (which
+    # clears it). In case you made a mistake and want to start again, you can
+    # clear the path using this public method.
+    #
+    def clear_path
+      self.path = []
+    end
+
+    # 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) ||
+        super
+    end
+
+    private
+
+    def known_action?(name)
+      ACTIONS.keys.include?(name)
+    end
+
+    def known_resource?(name)
+      RESOURCES.include?(name)
+    end
+
+    def known_exception?(name)
+      EXCEPTIONS.keys.include?(name)
+    end
+
+    def execute_request(action, params)
+      req = Request.new(
+        self, 
+        action: action,
+        params: params
+      )
+      clear_path
+      req.fetch
+    end
+
+    def build_path(resource, id)
+      self.path ||= []
+      self.path << resource
+      self.path << id if id
+      self
+    end
+  end
+end

data/lib/clubhouse_ruby/request.rb

@@ -0,0 +1,77 @@
+require 'net/http'
+
+module ClubhouseRuby
+  class Request
+    attr_accessor :uri, :action, :response_format, :params
+
+    # Prepares a fancy request object and ensures the inputs make as much sense
+    # as possible. It's still totally possible to just provide a path that
+    # doesn't match a real url though.
+    #
+    def initialize(clubhouse, action:, params: {})
+      raise ArgumentError unless validate_input(clubhouse, action, params)
+
+      self.params = params || {}
+      self.uri = construct_uri(clubhouse)
+      self.action = action
+      self.response_format = clubhouse.response_format
+    end
+
+    # Executes the http(s) request and provides the response with some
+    # additional decoration in a Hash.
+    #
+    def fetch
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |https|
+        req = Net::HTTP.const_get(action).new(uri)
+
+        set_body(req)
+        set_format_header(req)
+
+        wrap_response(https.request(req))
+      end
+    end
+
+    private
+
+    def validate_input(clubhouse, action, params)
+      clubhouse.is_a?(Clubhouse) &&
+        !clubhouse.path.nil? &&
+        !clubhouse.token.nil? &&
+        !clubhouse.response_format.nil? &&
+        ACTIONS.values.include?(action) &&
+        (params.is_a?(Hash) || params.nil?)
+    end
+
+    def construct_uri(clubhouse)
+      base_url = API_URL
+      path = clubhouse.path.map(&:to_s).map { |p| p.gsub('_', '-') }.join('/')
+      object_id = "/#{self.params.delete(:id)}" if self.params.key?(:id)
+      token = clubhouse.token
+      URI("#{base_url}#{path}#{object_id}?token=#{token}")
+    end
+
+    def set_format_header(req)
+      format_header = FORMATS[response_format][:headers][:header]
+      format_content = FORMATS[response_format][:headers][:content]
+      req[format_header] = format_content
+    end
+
+    def set_body(req)
+      req.body = params.to_json if params
+    end
+
+    def wrap_response(res)
+      begin
+        content = FORMATS[response_format][:parser].parse(res.body) if res.body
+      rescue FORMATS[response_format][:parser]::ParserError
+        content = res.body
+      end
+
+      {
+        code: res.code,
+        status: res.message,
+        content: content
+      }
+    end
+  end
+end

data/lib/clubhouse_ruby/version.rb

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

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: clubhouse_ruby
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Philip Castiglione
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- philipcastiglione@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clubhouse_ruby.gemspec
+- lib/clubhouse_ruby.rb
+- lib/clubhouse_ruby/constants.rb
+- lib/clubhouse_ruby/path_builder.rb
+- lib/clubhouse_ruby/request.rb
+- lib/clubhouse_ruby/version.rb
+homepage: https://github.com/PhilipCastiglione/clubhouse_ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: 'A lightweight ruby wrapper for the Clubhouse API: https://clubhouse.io/api/v1'
+test_files: []