clubhouse2 0.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 569d926370ed4d73fef21487292e1c20764ec833
-  data.tar.gz: 8d1563ec86cd3a03d1191b65586598dc2389e43c
+  metadata.gz: 7d4671759a9bb2c2702d1b3e236f8b46127dc5ed
+  data.tar.gz: 7edbf8d76327399603dce7c2c50002095c11ba1f
 SHA512:
-  metadata.gz: d1dc4c5513c835f155e22f77c9bbfa8d84f37aba8422d5ebd0dcadbcdf52c243e0a10911003d7827c1be0aeb7b57f56fa68eff1d6696479dc12fbe4d30354e1e
-  data.tar.gz: 796c45550edc55e53b76d3c74337f45d34c610b6a3ca2f26b2b1adb87bc4364b516b858df575f610b06de3d74466c9e5eef87dc1a4a92a3b31acc4cc3ac489b7
+  metadata.gz: e4735bbe5697325758b252859a42748c9fea3394ef26c4f44dd6a361cb2ce5ef0088d3f511e1f5eb872ebebfb5c561703babcd86098c0e1ccef1ed7a35595e46
+  data.tar.gz: 0da00f45ceb285c2ad6a5ec6c0d378c2668b92477e710f36d8c5c51ed54c415754d51996c2f9f439b23290c03b4aaab5e5ddbf36ca6fe92eed3101f3fe00e3c0

data/README.md

@@ -5,28 +5,39 @@ This is a resource-oriented ruby library for interacting with the Clubhouse v2 A
 ## How to use
 
 ### Initializing the client
-    require 'clubhouse2'
-    client = Clubhouse::Client.new(api_key: 'your_api_key')
+```ruby
+require 'clubhouse2'
+client = Clubhouse::Client.new(api_key: 'your_api_key')
+```
 
-### Querying
-
-#### Quick-start
+### Quick-start
 Get all stories being followed by a user called 'James'.
-	client.stories(follower_ids: client.member(name: 'James'))
+```ruby
+client.stories(follower_ids: client.member(name: 'James'))
+```
 
 Get all stories in the 'Testing' project in the 'Completed' state.
-	client.project(name: 'Testing').stories(workflow_state_id: client.workflow.state(name: 'Completed').id)
+```ruby
+client.project(name: 'Testing').stories(workflow_state_id: client.workflow.state(name: 'Completed'))
+```
 
 Get the names of all stories in the 'Testing' project
-	client.project(name: 'Testing').stories.collect(&:name)
+```ruby
+client.project(name: 'Testing').stories.collect(&:name)
+```
 
 Get all non-archived stories with the label 'Out Of Hours'
-	client.stories(archived: false, labels: client.label(name: 'Out Of Hours'))
+```ruby
+client.stories(archived: false, labels: client.label(name: 'Out Of Hours'))
+```
 
 Get all stories last updated more than 30 days ago
-	client.stories.select { |story| story.updated_at < Date.today - 30 }
+```ruby
+client.stories.select { |story| story.updated_at < Date.today - 30 }
+```
 
-#### Methods returning arrays of resources
+### Methods returning arrays of resources
+```ruby
 	client.projects 					# list all projects
 	client.milestones 					# list all milestones
 	client.members 						# list all members (users)
@@ -36,8 +47,9 @@ Get all stories last updated more than 30 days ago
 	client.workflows 					# list all workflows and states
 	client.labels 						# list all labels
 	client.teams 						# list all teams
-
-#### Methods returning single resources
+```
+### Methods returning single resources
+```ruby
 	client.project 						# list the first matching project
 	client.milestone 					# list the first matching milestone
 	client.member 						# list the first matching member (user)
@@ -47,15 +59,15 @@ Get all stories last updated more than 30 days ago
 	client.workflow 					# list the first matching workflow (usually Default)
 	client.label 						# list the first matching label
 	client.team 						# list the first matching team
-
-#### Filtering
+```
+### Filtering
 It's possible to filter by any resource property provided by the API. Multiple property filters can be specified.
-
+```ruby
 	client.project(id: 123)				# get a specific project
 	client.project(name: 'blah')		# get a project by name
 	client.projects(archived: true) 	# get all archived projects
 	client.project(id: 123).stories		# get stories belonging to a project
 	client.story(archived: false)		# get all non-archived stories
-
+```
 ### Notes
 Note that querying for stories is quicker when performed on a Project, rather than using the `client.projects` method. This is because stories are only available as children of a project, so building the global story array requires making an API call to every project.

data/VERSION

@@ -1 +1 @@
-0.0.2
+1.0.3

data/lib/clubhouse2/client.rb

@@ -33,8 +33,10 @@ module Clubhouse
 			@resources[resource_class] = nil
 		end
 
+		# Take all the provided properties, and filter out any resources that don't match.
+		# If the value of a property is an object with an ID, match on that ID instead (makes for tidier queries)
 		def filter(object_array, args)
-			object_array.reject { |s| args.collect { |k, v| not [ *s.send(k) ].include? v }.reduce(:|) }
+			object_array.reject { |s| args.collect { |k, v| not [ *s.send(k) ].include? v.respond_to?(:id) ? v.id : v }.reduce(:|) }
 		end
 
 		# or v.empty? if v.respond_to?(:empty?)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clubhouse2
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - James Denness