clubhouse2 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55bfc748af3d711fd8f90a3594f1272d53b94544
-  data.tar.gz: 45a1626fc86b551ae3b53ebf230c64e099d49682
+  metadata.gz: 569d926370ed4d73fef21487292e1c20764ec833
+  data.tar.gz: 8d1563ec86cd3a03d1191b65586598dc2389e43c
 SHA512:
-  metadata.gz: 0f3e1a806808f35df55b77564d5a82c041f6a1db89fa6781ec3506851a3fbb012cafd9192b1737e64ac1bb4746b4e0f07a7a858021196f5e4150e4dbc6610f61
-  data.tar.gz: a18e42aea643ef78213a2b8b4f035dba1cb5f13c62c8789746c6dc12132ca79dd0ad124b29a1bae2c3e518476bcbae0b3b16f5f0abd743e77aa672d910755f97
+  metadata.gz: d1dc4c5513c835f155e22f77c9bbfa8d84f37aba8422d5ebd0dcadbcdf52c243e0a10911003d7827c1be0aeb7b57f56fa68eff1d6696479dc12fbe4d30354e1e
+  data.tar.gz: 796c45550edc55e53b76d3c74337f45d34c610b6a3ca2f26b2b1adb87bc4364b516b858df575f610b06de3d74466c9e5eef87dc1a4a92a3b31acc4cc3ac489b7

data/README.md

@@ -0,0 +1,61 @@
+# Clubhouse API v2 Ruby Gem
+
+This is a resource-oriented ruby library for interacting with the Clubhouse v2 API. 
+
+## How to use
+
+### Initializing the client
+    require 'clubhouse2'
+    client = Clubhouse::Client.new(api_key: 'your_api_key')
+
+### Querying
+
+#### Quick-start
+Get all stories being followed by a user called 'James'.
+	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)
+
+Get the names of all stories in the 'Testing' project
+	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'))
+
+Get all stories last updated more than 30 days ago
+	client.stories.select { |story| story.updated_at < Date.today - 30 }
+
+#### Methods returning arrays of resources
+	client.projects 					# list all projects
+	client.milestones 					# list all milestones
+	client.members 						# list all members (users)
+	client.epics 						# list all epics
+	client.stories 						# list all stories, comments and tasks [WARNING: slow!]
+	client.categories 					# list all categories
+	client.workflows 					# list all workflows and states
+	client.labels 						# list all labels
+	client.teams 						# list all teams
+
+#### Methods returning single resources
+	client.project 						# list the first matching project
+	client.milestone 					# list the first matching milestone
+	client.member 						# list the first matching member (user)
+	client.epic 						# list the first matching epic
+	client.story 						# list the first matching story [WARNING: slow!]
+	client.category 					# list the first matching category
+	client.workflow 					# list the first matching workflow (usually Default)
+	client.label 						# list the first matching label
+	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.
+
+	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.1
+0.0.2

data/lib/clubhouse2/client.rb

@@ -15,7 +15,6 @@ module Clubhouse
 		end
 
 		def api_request(method, *params)
-			puts [method, *params].join(', ')
 			response = HTTP.headers(content_type: 'application/json').send(method, *params)
 			case response.code
 			when 429
@@ -120,6 +119,5 @@ module Clubhouse
 		def create_workflow(**args); create_object(:workflow, args); end
 		def workflows(**args); get_objects(:workflow, args); end
 		def workflow(**args); get_object(:workflow, args); end
-
 	end
 end

data/lib/clubhouse2/clubhouse_resource.rb

@@ -46,10 +46,14 @@ module Clubhouse
 
 		def set_properties(object)
 			object.each_pair do |k, v|
-				instance_variable_set('@' + k.to_s, v)
+				instance_variable_set('@' + k.to_s, value_format(k, v))
 			end
 		end
 
+		def value_format(key, value)
+			Date.iso8601(value) rescue value
+		end
+
 		# Empties resource cache
 		def flush
 			@client.flush(self.class)

data/lib/clubhouse2/workflow.rb

@@ -1,7 +1,7 @@
 module Clubhouse
 	class Workflow < ClubhouseResource		
 		def self.properties
-			[ :created_at, :default_state_id, :description, :entity_type, :id, :name, :states, :team_id, :updated_at ]
+			[ :created_at, :default_state_id, :description, :entity_type, :id, :name, :team_id, :updated_at ]
 		end
 
 		def initialize(client:, object:)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clubhouse2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - James Denness
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- README.md
 - VERSION
 - clubhouse2.gemspec
 - lib/clubhouse2.rb
@@ -74,7 +75,6 @@ files:
 - lib/clubhouse2/linked_file.rb
 - lib/clubhouse2/member.rb
 - lib/clubhouse2/milestone.rb
-- lib/clubhouse2/ops-migration.rb
 - lib/clubhouse2/profile.rb
 - lib/clubhouse2/project.rb
 - lib/clubhouse2/repository.rb

data/lib/clubhouse2/ops-migration.rb

@@ -1,110 +0,0 @@
-require 'clubhouse2'
-
-source_account = Clubhouse::Client.new(api_key: 'source_account_api_key')
-target_account = Clubhouse::Client.new(api_key: 'target_account_api_key')
-
-resolve_map = {}
-
-# Map of workflows which don't directly relate to workflows in the other account
-resolve_map[:workflow] = {
-	'Unscheduled' => 'Backlog',
-	'Ready for Deployment' => 'Awaiting UAT Deployment',
-	'Waiting for other team' => 'Blocked',
-	'Completed' => 'Done',
-	'Rejected' => 'Icebox'
-}
-
-# Map of members which aren't named the same in both accounts
-resolve_map[:member] = {
-	'James' => 'James Denness',
-}
-
-# This method looks up the corresponding ID of a resource in the other account, by matching its name.
-def resolve(source_client, target_client, resolve_map, type, id)
-	item = source_client.send(type, id: id)
-	if resolve_map[type]
-		counterpart = resolve_map[type][item.name] || item.name
-	else
-		counterpart = item.name
-	end
-	target_client.send(type, name: counterpart)&.id
-end
-
-# We need to create the empty projects before we can create epics
-source_account.projects.each do |this_project|
-	target_account.create_project(
-		this_project.to_h.merge({
-			follower_ids: this_project.follower_ids.collect { |f| resolve(source_account, target_account, resolve_map, :member, f) }
-		})
-	) unless resolve(source_account, target_account, resolve_map, :project, this_project.id)
-end
-
-# Create labels
-source_account.labels.each do |this_label|
-	target_account.create_label(this_label.to_h) unless resolve(source_account, target_account, resolve_map, :label, this_label.id)
-end
-
-# Create categories
-source_account.categories.each do |this_category|
-	target_account.create_category(this_category.to_h) unless resolve(source_account, target_account, resolve_map, :category, this_category.id)
-end
-
-# Create milestones
-source_account.milestones.each do |this_milestone|
-	new_milestone = target_account.create_milestone(
-		this_milestone.to_h.merge({
-			labels: this_milestone.categories.collect { |c| resolve(source_account, target_account, resolve_map, :category, c ) }
-		})
-	) unless target_account.milestone(name: this_milestone.name)
-end
-
-# Create epics
-source_account.epics.each do |this_epic|
-	new_epic = target_account.create_epic(
-		this_epic.to_h.merge({
-			follower_ids: this_epic.follower_ids.collect { |f| resolve(source_account, target_account, resolve_map, :member, f) },
-			owner_ids: this_epic.owner_ids.collect { |o| resolve(source_account, target_account, resolve_map, :member, o) },
-			labels: this_epic.labels.collect { |l| resolve(source_account, target_account, resolve_map, :label, l ) },
-			started_at_override: this_epic.started_at,
-			completed_at_override: this_epic.completed_at,
-			milestone_id: resolve(source_account, target_account, resolve_map, :milestone, this_epic.milestone_id)
-		})
-	) unless target_account.epic(name: this_epic.name)
-end
-
-# Fill the projects with stories
-source_account.projects.each do |this_project|
-	target_account_project = target_account.project(id: resolve(source_account, target_account, resolve_map, :project, this_project.id))
-	this_project.stories.each do |this_story|
-		new_story = target_account.create_story(
-			this_story.to_h.merge({
-				project_id: target_account_project.id,
-				epic_id: (resolve(source_account, target_account, resolve_map, :epic, this_story.epic_id) if this_story.epic_id),
-				follower_ids: this_story.follower_ids.collect { |f| resolve(source_account, target_account, resolve_map, :member, f) },
-				owner_ids: this_story.owner_ids.collect { |o| resolve(source_account, target_account, resolve_map, :member, o) },
-				requested_by_id: resolve(source_account, target_account, resolve_map, :member, this_story.requested_by_id),
-			})
-		) unless target_account_project.story(name: this_story.name)
-	end
-end
-
-# Restore story links
-source_account.story_links.each do |this_link|
-	begin
-		target_account.create_story_link(
-			this_link.to_h.merge({
-				object_id: resolve(source_account, target_account, resolve_map, :story, this_link.object_id),
-				subject_id: resolve(source_account, target_account, resolve_map, :story, this_link.subject_id)
-			})
-		) unless target_account.story_link(object_id: resolve(source_account, target_account, resolve_map, :story, this_link.object_id), subject_id: resolve(source_account, target_account, resolve_map, :story, this_link.subject_id))
-	rescue Clubhouse::ClubhouseAPIError => e
-		if e.message[/duplicated/]
-			next
-		else
-			raise e
-		end
-	end
-end
-
-
-