clubhouse2 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d4671759a9bb2c2702d1b3e236f8b46127dc5ed
-  data.tar.gz: 7edbf8d76327399603dce7c2c50002095c11ba1f
+  metadata.gz: b16f448e16fc7ce33fd39bbd93278cc53383f7f9
+  data.tar.gz: 5e38fa96e9f8caea41690a94859bbcd68c18684f
 SHA512:
-  metadata.gz: e4735bbe5697325758b252859a42748c9fea3394ef26c4f44dd6a361cb2ce5ef0088d3f511e1f5eb872ebebfb5c561703babcd86098c0e1ccef1ed7a35595e46
-  data.tar.gz: 0da00f45ceb285c2ad6a5ec6c0d378c2668b92477e710f36d8c5c51ed54c415754d51996c2f9f439b23290c03b4aaab5e5ddbf36ca6fe92eed3101f3fe00e3c0
+  metadata.gz: ef29340fa36a3746ced78c18d7c18624cb1135c4b870fff74e4c1d69edf4649f5b2c2044fc4b692fc244369af0a94bcdab6dc7bb8b39791da0fcb149a1b1e2a0
+  data.tar.gz: 9193677a35bcf663e1d679a4763d8066cdc6b8067c3ff93327e83321d02ae6fcb9b0912da3a6cabe763113bc37758da2c64a64aa8465168ea5875a492105d824

data/README.md

@@ -11,6 +11,7 @@ client = Clubhouse::Client.new(api_key: 'your_api_key')
 ```
 
 ### Quick-start
+#### Queries
 Get all stories being followed by a user called 'James'.
 ```ruby
 client.stories(follower_ids: client.member(name: 'James'))
@@ -36,6 +37,56 @@ Get all stories last updated more than 30 days ago
 client.stories.select { |story| story.updated_at < Date.today - 30 }
 ```
 
+Get a list of all story states in the default workflow
+```ruby
+client.workflow.states
+```
+
+#### Creating resources
+See the official Clubhouse API documentation for valid properties to use here:
+https://clubhouse.io/api/rest/v2/
+
+Create a new story in the 'Testing' project
+```ruby
+client.project(name: 'Testing').create_story( **...** )
+client.create_story(project_id: client.project(name: 'Testing'), **...** )
+```
+
+#### Updating resources
+Updating a property of a resource can be achieved simply by using assignment operators, as shown in the examples below.
+
+See the official Clubhouse API documentation for valid properties to use here:
+https://clubhouse.io/api/rest/v2/
+
+Change the name of a story
+```ruby
+client.story(name: 'Old name').name = 'New name'
+client.story(id: 123).name = 'New name'
+```
+
+Add a new follower to a story
+```ruby
+client.story(id: 123).follower_ids += [ client.member(name: 'Jeff') ]
+```
+
+Assign a story to an epic
+```ruby
+client.story(id: 123).epic_id = client.epic(name: 'Awesome')
+```
+
+#### Deleting resources
+Deletion is possible by using the `delete!` method, which is available on most resources. Some resources can only be deleted from the web interface.
+
+Delete an epic
+```ruby
+client.epic(id: 123).delete!
+```
+
+Delete all stories in the 'Testing' project
+```ruby
+client.project(name: 'Testing').stories.each(&:delete!)
+```
+
 ### Methods returning arrays of resources
 ```ruby
 	client.projects 					# list all projects
@@ -61,7 +112,7 @@ client.stories.select { |story| story.updated_at < Date.today - 30 }
 	client.team 						# list the first matching team
 ```
 ### Filtering
-It's possible to filter by any resource property provided by the API. Multiple property filters can be specified.
+It's possible to filter by any resource property provided by the API. Multiple property filters can be specified. Filters match any member of an array, for example you can filter `stories` by `follower_ids`, which will match any stories for which the given member, or members, are followers.
 ```ruby
 	client.project(id: 123)				# get a specific project
 	client.project(name: 'blah')		# get a project by name

data/VERSION

@@ -1 +1 @@
-1.0.3
+1.0.4

data/lib/clubhouse2/clubhouse_resource.rb

@@ -11,7 +11,8 @@ module Clubhouse
 			[
 				:archived, :days_to_thermometer, :entity_type, :id, :show_thermometer, :stats, :created_at, :updated_at,
 				:started_at, :completed_at, :comments, :position, :started, :project_ids, :completed, :blocker, :moved_at,
-				:task_ids, :files, :comment_ids, :workflow_state_id, :story_links, :mention_ids, :file_ids, :linked_file_ids
+				:task_ids, :files, :comment_ids, :workflow_state_id, :story_links, :mention_ids, :file_ids, :linked_file_ids,
+				:tasks
 			]
 		end
 
@@ -36,7 +37,8 @@ module Clubhouse
 			self.class.properties.each do |this_property|
 				self.class.class_eval { attr_accessor(this_property.to_sym) }
 				self.class.send(:define_method, (this_property.to_s + '=').to_sym) do |value|
-					update({ this_property => value })
+					update({ this_property => resolve_to_ids(value) })
+					instance_variable_set('@' + this_property.to_s, resolve_to_ids(value))
 				end
 			end
 
@@ -44,6 +46,11 @@ module Clubhouse
 			self
 		end
 
+		def resolve_to_ids(object)
+			return object.collect { |o| resolve_to_ids(o) } if object.is_a? Array
+			(object.respond_to?(:id) ? object.id : object)
+		end
+
 		def set_properties(object)
 			object.each_pair do |k, v|
 				instance_variable_set('@' + k.to_s, value_format(k, v))
@@ -60,7 +67,7 @@ module Clubhouse
 		end
 
 		def update(args = {})
-			new_params = to_h.merge(args).reject { |k, v| self.class.property_filter_update.include? k.to_sym }
+			new_params = args.reject { |k, v| self.class.property_filter_update.include? k.to_sym }
 			validate(new_params)
 			flush
 			@client.api_request(:put, @client.url(api_url), :json => new_params)

data/lib/clubhouse2/story.rb

@@ -43,6 +43,12 @@ module Clubhouse
 			end
 		end
 
+		def update(**args)
+			# The API won't let us try to update the project ID without changing it
+			args.delete(:project_id) if args[:project_id] == @project_id
+			super
+		end
+
 		def create_task(**args)
 			Task.validate(**args)
 			@tasks = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clubhouse2
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - James Denness
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-09 00:00:00.000000000 Z
+date: 2017-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http