clubhouse.io-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f93cf2edd6cf7b164f2b67db7bb944d802a22ac4
+  data.tar.gz: 1fe18db6783c105df17cf32af22eeb36307bb5f3
+SHA512:
+  metadata.gz: f6ad599058906edba43cbeeba98051d23fb79dfbe584e302041530d1b9b5da5e662c9ac2ef4646fd4feab8887f9c794655f2f45d6452e4b367f7fa8d719c53a2
+  data.tar.gz: eb840ce27bd493357226b2c152e5dab0d86fd3f7a78423b08f90b012afd04e6523f7c99abeb5163089315ea3d7ee1cfa6a91def57a3c9f1a0c44f52251b003c6

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jon Normington
+
+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,70 @@
+[![CircleCI](https://circleci.com/gh/jnormington/clubhouse.io-ruby.svg?style=svg)](https://circleci.com/gh/jnormington/clubhouse.io-ruby)
+
+# Clubhouse
+
+This gem provides a basic representation of the Clubhouse.io API.
+
+If you don't know what [Clubhouse](https://clubhouse.io) is, I recommend you check it out, its an awesome project management system in its early days and can only get better.
+
+Their API documentation is at the following address [https://clubhouse.io/api/v1/](https://clubhouse.io/api/v1/) as you will need it for reference.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clubhouse.io-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clubhouse.io-ruby
+
+## Usage
+
+### Setting up a client
+
+Before we start its best to setup a default client if you are just using it with only one token.
+
+You can generate a token for clubhouse by going to the account section and generating a new token
+
+```ruby
+Clubhouse.default_client = Clubhouse::Client.new('YOUR_TOKEN_HERE')
+```
+
+Now we are ready to start creating stories. In its basic form this is how you create a story
+
+This will create a new story in the first project that is returned from the API in the all projects request.
+
+```ruby
+story = Clubhouse::Story.new(name:'My Story', project_id: Clubhouse::Project.all.first.id)
+story.save
+```
+
+You can check out all the other docs on other resources with examples [here](doc)
+
+* [Epics](docs/epics.md)
+* [Files](docs/files.md)
+* [Labels](docs/labels.md)
+* [Linked-Files](docs/linked_files.md)
+* [Projects](docs/projects.md)
+* [Story-Links](docs/story_links.md)
+* [Stories](docs/stories.md)
+  * [Comments](docs/comments.md)
+  * [Tasks](docs/tasks.md)
+* [Users](docs/users.md)
+* [Workflows](docs/workflows.md)
+
+
+## Contributing
+
+Bug reports and/or pull requests are welcome
+
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clubhouse"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/clubhouse.io-ruby.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clubhouse/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clubhouse.io-ruby"
+  spec.version       = Clubhouse::VERSION
+  spec.authors       = ["Jon Normington"]
+  spec.email         = ["jnormington@users.noreply.github.com"]
+
+  spec.summary       = %q{Clubhouse.io ruby gem for the API}
+  spec.description   = "A basic ruby gem for interacting with the Clubhouse.io API"
+  spec.homepage      = "https://github.com/jnormington/clubhouse.io-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 "webmock", "~>2.1"
+end

data/docs/comments.md

@@ -0,0 +1,64 @@
+# Comments
+
+This assumes that you have setup the default client, or will inject your own client.
+
+It is recommended to create comments from a story object as described [here](stories.md)
+
+## Creating
+
+```ruby
+comment = Clubhouse::Comment.new(
+  story_id: 34,
+  text: 'My comment'
+)
+
+comment.save
+```
+
+Once saved the comment object will be reloaded with the response from clubhouse so now your new
+object will have the created_at and updated_at time that is returned from the API.
+
+### Required Fields
+* story_id
+* text
+
+
+## Updating
+
+```ruby
+comment = Clubhouse::Comment.find(34, 8)
+
+comment.text = "Updated comment"
+comment.save # Save works for both creating and updating
+
+=> <#Clubhouse::Comment... >
+
+```
+
+## Finding by id
+
+Finding a comment is different to all other resources the find method takes two arguments
+
+* story_id
+* comment_id
+
+```ruby
+comment = Clubhouse::Comment.find(34, 8)
+
+=> #<Clubhouse::Comment:0x007ffcd58002d0 @text="Updated comment", @id=8 ... >
+```
+
+## Deleting by id
+
+Deleting a comment is different to all other resources the delete method takes two arguments
+
+* story_id
+* comment_id
+
+When an empty hash is returned this means it was successfull otherwise it will raise an exception
+
+```ruby
+Clubhouse::Comment.delete(34, 8)
+
+=> {}
+```

data/docs/epics.md

@@ -0,0 +1,64 @@
+# Epics
+
+This assumes that you have setup the default client, or will inject your own client.
+
+## Creating
+
+```ruby
+epic = Clubhouse::Epic.new(
+  name: "Epic One",
+  description: 'Epic description',
+  state: 'in progress'
+)
+
+epic.save
+```
+
+Once saved the epic object will be reloaded with the response from clubhouse so now your new
+object will have the created_at and updated_at time that is returned from the API.
+
+### Required Fields
+* name
+
+
+## Updating
+
+```ruby
+epic = Clubhouse::Epic.new(name: "Epic One").save
+
+epic.state = 'in progress'
+epic.save # Save works for both creating and updating
+
+=> <#Clubhouse::Epic... >
+
+```
+
+## Finding by id
+
+```ruby
+epic = Clubhouse::Epic.find(3)
+
+=> #<Clubhouse::Epic:0x007ffcd58002d0 @state='to do', @id=3 ... >
+```
+
+## Deleting by id
+
+When an empty hash is returned this means it was successfull otherwise it will raise an exception
+
+```ruby
+Clubhouse::Epic.delete(3)
+
+=> {}
+```
+
+## Listing
+
+Returns a list of all epics
+
+```ruby
+Clubhouse::Epic.all
+
+=> [#<Clubhouse::Epic:0x007fb1422da640 @archived=false, @created_at="2016-08-31T22:53:47Z",
+@deadline=nil, @description="", @external_id=nil, @follower_ids=[], @name="Epic One", @owner_ids=[],
+@state="to do", @updated_at="2016-09-24T16:31:50Z", @id=11, @comments=[], @position=0>]
+```

data/docs/files.md

@@ -0,0 +1,48 @@
+# Files
+
+This assumes that you have setup the default client, or will inject your own client.
+
+## Creating
+
+You are unable to create files but can create linked files [here](linked_files.md)
+
+## Updating
+
+```ruby
+file = Clubhouse::File.find(12)
+
+file.name = 'New file name'
+file.description = 'File description'
+file.save
+
+=> <#Clubhouse::File... >
+
+```
+
+## Finding by id
+
+```ruby
+file = Clubhouse::File.find(12)
+
+=> #<Clubhouse::File:0x007ffcd58002d0 @name='Screenshot 1', @id=12 ... >
+```
+
+## Deleting by id
+
+When an empty hash is returned this means it was successfull otherwise it will raise an exception
+
+```ruby
+Clubhouse::File.delete(12)
+
+=> {}
+```
+
+## Listing
+
+Returns a list of all files uploaded via cllubhouse web
+
+```ruby
+Clubhouse::File.all
+
+=> [#<Clubhouse::File:0x007fb1422b0a98 @created_at="2016-09-24T16:38:04Z", @description=nil, @external_id=nil, @name="Screenshot 1"...>]
+```

data/docs/labels.md

@@ -0,0 +1,49 @@
+# Labels
+
+This assumes that you have setup the default client, or will inject your own client.
+
+## Creating
+
+```ruby
+label = Clubhouse::Label.new(name: "Label One")
+label.save
+```
+
+Once saved the label object will be reloaded with the response from clubhouse so now your new
+object will have the created_at and updated_at time that is returned from the API.
+
+### Required Fields
+* name
+
+
+## Updating
+
+```ruby
+label = Clubhouse::Label.find(8)
+
+label.name = "Label updated"
+label.save # Save works for both creating and updating
+
+=> <#Clubhouse::Label:0x007fb161230438 @name="Label updated" ... >
+
+```
+
+## Deleting by id
+
+When an empty hash is returned this means it was successfull otherwise it will raise an exception
+
+```ruby
+Clubhouse::Label.delete(8)
+
+=> {}
+```
+
+## Listing
+
+Returns a list of all labels
+
+```ruby
+Clubhouse::Label.all
+
+=> [#<Clubhouse::Label:0x007fb142440458 @name="PT"...>]
+```

data/docs/linked_files.md

@@ -0,0 +1,64 @@
+# LinkedFiles
+
+This assumes that you have setup the default client, or will inject your own client.
+
+## Creating
+
+```ruby
+linked_file = Clubhouse::LinkedFile.new(
+  name: "LinkedFile One",
+  type: 'url',
+  url: 'https://dropbox.com/1/files/image.png'
+)
+
+linked_file.save
+```
+
+Once saved the linked file object will be reloaded with the response from clubhouse so now your new
+object will have the created_at and updated_at time that is returned from the API.
+
+### Required Fields
+* name
+* type (google, url, dropbox, box, onedrive)
+* url
+
+
+## Updating
+
+```ruby
+linked_file = Clubhouse::LinkedFile.find(23)
+
+linked_file.thumbnail_url = 'https://dropbox.com/1/files/image.png?size=thumbnail'
+linked_file.save # Save works for both creating and updating
+
+=> <#Clubhouse::LinkedFile... >
+
+```
+
+## Finding by id
+
+```ruby
+linked_file = Clubhouse::LinkedFile.find(23)
+
+=> #<Clubhouse::LinkedFile:0x007ffcd58002d0 @url='https://dropbox.com/1/file/image.png', @id=23 ... >
+```
+
+## Deleting by id
+
+When an empty hash is returned this means it was successfull otherwise it will raise an exception
+
+```ruby
+Clubhouse::LinkedFile.delete(23)
+
+=> {}
+```
+
+## Listing
+
+Returns a list of all linked files uploaded by the API
+
+```ruby
+Clubhouse::LinkedFile.all
+
+=> [#<Clubhouse::LinkedFile:0x007fb142223508 @content_type="", @description="", @name="attachment0", @size=230, @story_id=nil, @thumbnail_u...>]
+```