youtrack 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3748058fee393084318fe12d0ad64da23f7ffbbd
-  data.tar.gz: 62f237bcbdd3979fb23b45d56a0e302fe81dc92a
+  metadata.gz: b49b0b2fa1572425997a8638aed4498b15c8169b
+  data.tar.gz: 6aab1f47e3f3d7d5b0af1ae408d1a6f1dd07eb01
 SHA512:
-  metadata.gz: 6a2881cc03b50f271e650ed30b3574113d873d14f34f6a28060d91aff7b72cad39a172347f5e091cb96c9e65952c96cbd67f6c9130c64ec9f538fc23ae38e982
-  data.tar.gz: 8967a20c522616ce0e1d6641793b6a7136e34b38e35dbd04771f5d148f209c0a7029c29035bdb1f4bcd3b6d9937a1575d444b9b52f18d5d4e40681d9aa731a6e
+  metadata.gz: 4b6b76023f8477b95215d897019837f6c6132c0ab6e0a3c669010d76f76bced792c4726332072a22181fd39c2a316c466e80101b4221910bc228cdd5816f0b89
+  data.tar.gz: 6d33cc644eec81607418b502e0a3bd90a22188170353fc054f5db7532e6b2981bcb7efd13bb2b594132b402c3c32deed8b5cc54da8d2caf3550520f5b0da7aad

data/examples/authentication.rb

@@ -0,0 +1,12 @@
+require "youtrack"
+
+# Setup the client configuration
+client = Youtrack::Client.new do |c|
+  c.url = "http://example.your-youtrack.com"
+  c.login = "demo"
+  c.password = "demo"
+end
+
+# connect to the youtrack endpoint
+# and save cookies in the client object
+client.connect!

data/examples/issues.rb

@@ -0,0 +1,53 @@
+require "youtrack"
+
+# Setup the client configuration
+client = Youtrack::Client.new do |c|
+  c.url = "http://example.your-youtrack.com"
+  c.login = "demo"
+  c.password = "demo"
+end
+
+# connect to the youtrack endpoint
+# and save cookies in the client object
+client.connect!
+
+
+# Get the issue resource inheriting cookies
+# from client
+issue_resource = client.issues
+
+# Find an issue by ID
+issue_resource.find("TT-6")
+
+# Check if an issue exists
+issue_resource.exists?("TT-6")
+
+# Getting issue associated data
+issue_resource.get_history_for("TT-6")
+issue_resource.get_changes_for("TT-6")
+issue_resource.get_attachments_for("TT-6")
+issue_resource.get_comments_for("TT-6")
+issue_resource.get_links_for("TT-6")
+
+# Create an Issue
+issue_resource.create(
+  project: "TT",
+  summary: "An example Bug",
+  description: "This Bug is evil"
+)
+
+# Update an Issue
+issue_id = "TT-6"
+issue_resource.update( issue_id , summary: "Evil Bug")
+
+# Delete
+issue_resource.destroy(issue_id)
+
+# Add attachments to an issue
+data = File.open("/tmp/dummy.txt")
+content_type = "text/plain"
+filename = "dummy.txt"
+issue_resource.add_attachment(issue_id, data, content_type, filename )
+
+# Add comments to an issue
+issue_resource.add_comment(issue_id, comment: "This bug has been fixed")

data/examples/projects.rb

@@ -0,0 +1,48 @@
+require "youtrack"
+
+# Setup the client configuration
+client = Youtrack::Client.new do |c|
+  c.url = "http://example.your-youtrack.com"
+  c.login = "demo"
+  c.password = "demo"
+end
+
+# connect to the youtrack endpoint
+# and save cookies in the client object
+client.connect!
+
+
+
+# create a project resource
+# that inherits the connection
+# from the client
+project_resource = client.projects
+
+# Get all accessible projects
+project_list = project_resource.get_accessible_projects
+
+# Get all issues for a particular project
+project_id = "TT"
+issue_list   = project_resource.get_issues_for(project_id)
+
+# These methods require that the login/password user
+# have admin privileges
+
+# Get all projects
+project_resource.all
+
+# Find a project by ID (shortName in youTrack vernacular)
+project_resource.find("TT")
+
+# Delete a project
+project_resource.destroy("TT")
+
+# Create a project
+# All are required except description
+project_resource.create(
+  projectId: "CC",
+  projectName: "Cool Cats",
+  startingNumber: 4,
+  projectLeadLogin: "demo",
+  description: "A Project about really awesome cats"
+)

data/lib/youtrack/resources/project.rb

@@ -4,7 +4,7 @@ module Youtrack
     # ==================
     # USER Methods
     # ==================
-    def accessible_projects
+    def get_accessible_projects
       get('project/all')
       response.parsed_response
     end
@@ -50,4 +50,4 @@ module Youtrack
     end
     
   end
-end
+end

data/lib/youtrack/version.rb

@@ -1,3 +1,3 @@
 module Youtrack
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/youtrack/resources/user_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe Youtrack::User do
+  let(:users) do
+    client = Youtrack::Client.new do |c|
+      c.url = "https://example.com"
+      c.login = "test"
+      c.password = "test"
+    end
+    client.users
+  end
+
+  describe "api methods" do
+    it "#current" do
+      users.method(:current).arity.should eq(0)
+    end
+
+    it "#get_by_login" do
+      users.method(:get_by_login).arity.should eq(1)
+    end
+
+    it "#get_saved_searches_for" do
+      users.method(:get_saved_searches_for).arity.should eq(1)
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: youtrack
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - John Faucett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-25 00:00:00.000000000 Z
+date: 2014-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -124,6 +124,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/authentication.rb
+- examples/issues.rb
+- examples/projects.rb
+- examples/users.rb
 - features/client/new_client_session.feature
 - features/step_definitions/client/client_steps.rb
 - features/support/env.rb
@@ -141,6 +145,7 @@ files:
 - spec/fixtures/login_header.json
 - spec/spec_helper.rb
 - spec/youtrack/client_spec.rb
+- spec/youtrack/resources/user_spec.rb
 - youtrack.gemspec
 homepage: http://jwaterfaucett.github.io/youtrack/
 licenses:
@@ -162,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A Ruby REST API Client for JetBrains youTrack software
@@ -177,3 +182,4 @@ test_files:
 - spec/fixtures/login_header.json
 - spec/spec_helper.rb
 - spec/youtrack/client_spec.rb
+- spec/youtrack/resources/user_spec.rb