youtrack 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20fcd027f9f2ccbe21f3c3899ece54d81ffd667f
-  data.tar.gz: 418054623251575f8917b2a3c65ee9ec0001f0da
+  metadata.gz: 07d949e716b29198f4623d61816059a3a1c0e4d9
+  data.tar.gz: d1a7bf3b1853e5439a116f8188fe31e71dcac0a6
 SHA512:
-  metadata.gz: 04739f2ccd49272e0542e32c347e5958c5d9e50e79085867ed687d7e360f619626e21c3b187dbb1d1753f6dabea07bf59a186165e59d4db32da5e8d2db7e3d08
-  data.tar.gz: 6bdac860776d6d68ba44bddfe934122650b278d16217751b8acc120e4f2e69d2a19262df1d714a929a24c425e0a34099d4aa8a0c4077d27d02a2dbc5a6c471da
+  metadata.gz: f39f8d9e6e52a8b715aa5dd79715c2aaf6d35ff31ef972f9ceb672722474f7682f97693f5be34b46057ed57c37edd72124fba8a56a5f0dced0d6e0b6638fdcd2
+  data.tar.gz: a842b493ddacb75d251a4c519150af698c3b17fe31953badcff263ba311344b93f2875be76cd07514afa7342f48ae13ae6664bca43e2033b06642e9e0c39427f

data/.ruby-gemset

@@ -0,0 +1 @@
+youtrack

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/features/client/new_client_session.feature

@@ -8,5 +8,12 @@ Feature: New Client Session
     Given I create a new Client
     When I set the Client url to point to the Server
       And I enter the correct login credentials
-      And I connect
+      And I connect ok
     Then I should be connected to the Server
+
+  Scenario: failing to start a new session
+    Given I create a new Client
+    When I set the Client url to point to the Server
+      And I enter incorrect login credentials
+      And I connect with error
+    Then I should receive an error Response

data/features/step_definitions/client/client_steps.rb

@@ -1,3 +1,10 @@
+def login_stub
+  stub_request(:post, YServer::Endpoint + "/login").with( body: @client.credentials_hash )
+end
+
+def fixture(filename)
+  File.join(YServer::FIXTURE_PATH, filename)
+end
 
 Given /^I create a new Client$/ do
   @client = Youtrack::Client.new
@@ -8,12 +15,23 @@ Given /^I enter the correct login credentials$/ do
   step "I set the Client#password= to <#{YServer::Password}>"
 end
 
+Given /^I enter incorrect login credentials$/ do
+  step "I set the Client#login= to <#{YServer::Lorem}>"
+  step "I set the Client#password= to <#{YServer::Lorem}>"
+end
+
 Given /^I set the Client url to point to the Server$/ do
   @client.url = YServer::URL
 end
 
-Given /^I connect$/ do
-  @client.login!
+Given /^I connect ok$/ do
+  login_stub.to_return( body: fixture('login_body_ok.xml'), headers: { 'Content-Type' => 'application/xml; charset=UTF-8' } )
+  @client.connect!
+end
+
+Given /^I connect with error$/ do
+  login_stub.to_return( body: fixture('login_body_error.xml'), headers: { 'Content-Type' => 'application/xml; charset=UTF-8' } )
+  @client.connect!
 end
 
 Given /^I set the Client#([a-zA-Z_=]+) to <([a-zA-Z0-9_-]+)>$/ do |method, value|
@@ -23,3 +41,10 @@ end
 Then /^I should be connected to the Server$/ do
   @client.response.parsed_response["login"].should eq("ok")
 end
+
+Then /^I should receive an error response from the Server$/ do
+end
+
+Then(/^I should receive an error Response$/) do
+  @client.response.parsed_response['error'].should eq('Incorrect login or password.')
+end

data/features/support/env.rb

@@ -1,10 +1,14 @@
 require "youtrack"
-require "webmock/cucumber"
 
 module YServer
   URL = "https://youtrackserver.com"
+  Endpoint = "#{URL}/rest"
   Login = "root"
+  Lorem = 'lorem'
   Password = "root"
+  FIXTURE_PATH = File.expand_path('../../../spec/fixtures', __FILE__ )
 end
 
-
+require 'webmock/cucumber'
+World(WebMock::API, WebMock::Matchers)
+WebMock.allow_net_connect!

data/features/support/webmock.rb

@@ -1,20 +1 @@
-include WebMock::API
 
-def server_url_for(endpoint, options={})
-  base = "#{YServer::URL}/rest/#{endpoint}"
-  if options[:query]
-    base += "?#{options[:query]}"
-  end
-end
-
-
-# STUBS
-
-# login
-stub_request(:post, server_url_for("login", query: "login=#{YServer::Password}&password=#{YServer::Login}"))
-  .to_return(
-    body: "<login>ok</login>",
-    headers: {
-      "Server" => "Jetty(6.1.23)",
-      "Content-Type" => "application/xml;charset=UTF-8"
-  })

data/features/support/world.rb

@@ -1 +1 @@
-World(YServer)
+World(YServer)

data/lib/youtrack.rb

@@ -1,6 +1,10 @@
 require "httparty"
 
 module Youtrack
-  autoload :Client, "youtrack/client"
-  autoload :VERSION, "youtrack/version"
+  autoload :Client,   "youtrack/client"
+  autoload :VERSION,  "youtrack/version"
+  autoload :Base,     "youtrack/resources/base"
+  autoload :Issue,    "youtrack/resources/issue"
+  autoload :Project,  "youtrack/resources/project"
+  autoload :User,     "youtrack/resources/user"
 end

data/lib/youtrack/client.rb

@@ -1,6 +1,5 @@
 module Youtrack
   class Client
-    include HTTParty
 
     # holds the youTrack Server url
     # defaults to nil
@@ -15,22 +14,62 @@ module Youtrack
     attr_accessor :password
 
     # stores the response object
-    attr_accessor :response
+    attr_accessor :connection
+
+    # stores the auth_headers
+    attr_accessor :cookies
+
+    # stores the scope of all subsequent api calls
+    attr_accessor :admin
+
+    def admin?
+      true == @admin
+    end
 
     def initialize(options={})
+      @cookies = {}
+      @admin   = false
     end
 
-    def server_endpoint
-      @server_endpoint ||= File.join(url, "rest")
+    # the server endpoint
+    def endpoint
+      @endpoint = File.join(url, 'rest')
     end
 
     def credentials_hash
       { login: login, password: password }
     end
 
-    def login!
-      @response = self.class.post(server_endpoint + "/login", { query: credentials_hash })
+
+    # Makes a login call and sets the Cookie headers
+    # 
+    # Returns the status code of the connection call
+    def connect!
+      @connection = HTTParty.post(File.join(url, "rest/user/login"), body: credentials_hash )
+      @cookies['Cookie'] = @connection.headers['set-cookie']
+      @connection.code
+    end
+
+    def connected?
+      !!(connection && connection.headers['set-cookie'])
     end
 
+    def users
+      resource(:user).new(self)
+    end
+
+    def projects
+      resource(:project).new(self)
+    end
+
+    def issues
+      resource(:issue).new(self)
+    end
+
+    private
+
+      def resource(resource_name)
+        Youtrack.const_get(resource_name.to_s.capitalize)
+      end
   end
 end

data/lib/youtrack/resources/base.rb

@@ -0,0 +1,53 @@
+module Youtrack
+  class Base
+    include HTTParty
+
+    # The base route URL
+    attr_accessor :base_url
+
+    # The Server Endpoint
+    attr_accessor :service
+
+    # Stores the response of the previous request
+    attr_accessor :response
+
+
+    def initialize(client)
+      @service = client
+      @base_url = @service.endpoint
+    end
+
+    protected
+
+      def join(*args)
+        File.join(*args)
+      end
+
+      def prepare_options(options={})
+        options[:headers] ||= {}
+        options[:headers]['Cookie'] = service.cookies['Cookie']
+        options
+      end
+      
+      def post(path, options={})
+        options = prepare_options(options)
+        @response = self.class.post( join(base_url, path), options )
+      end
+
+      def put(path, options={})
+        options = prepare_options(options)
+        @response = self.class.put( join(base_url, path), options )
+      end
+
+      def get(path, options={})
+        options = prepare_options(options)
+        @response = self.class.get( join(base_url, path), options )
+      end
+
+      def delete(path, options={})
+        options = prepare_options(options)
+        @response = self.class.delete( join(base_url, path), options )
+      end
+
+  end
+end

data/lib/youtrack/resources/issue.rb

@@ -0,0 +1,22 @@
+module Youtrack
+  class Issue < Base
+
+
+    # ==================
+    # USER Methods
+    # ==================
+    
+
+    # Create a New Issue
+    # project  string  ID of a project to add new issue to.
+    # summary  string  Short summary for the new issue.
+    # description  string  Description for the new issue.
+    # attachments  file in "multipart/form-data" format  One or several files in "multipart/form-data" format that should be attached to the new issue.
+    # permittedGroup   string  Set visibility for the new issue, that is: Specify a user group to which the issue will be visible.
+    def create(attributes={})
+      put("/issue", body: attributes)
+      response
+    end
+    
+  end
+end

data/lib/youtrack/resources/project.rb

@@ -0,0 +1,43 @@
+module Youtrack
+  class Project < Base
+
+    # ==================
+    # USER Methods
+    # ==================
+    def accessible_projects
+      get('/project/all')
+      response.parsed_response
+    end
+
+    # ==================
+    # ADMIN Methods
+    # ==================
+    def all
+      get('/admin/project')
+      response.parsed_response
+    end
+
+    def find(project_id)
+      get("/admin/project/#{project_id}")
+      response.parsed_response
+    end
+
+    # required attributes
+    # 
+    # projectId  string required Unique identifier of a project to be created. This short name will be used as prefix in issue IDs for this project.
+    # projectName  string required Full name of a new project. Must be unique.
+    # startingNumber   integer  required Number to assign to the next manually created issue.
+    # projectLeadLogin   string required Login name of a user to be assigned as a project leader.
+    # description  string  Optional description of the new project
+    def create(attributes={})
+      put("admin/project/#{attributes[:projectId]}", body: attributes)
+      response
+    end
+
+    def destroy(project_id)
+      delete("/admin/project/#{project_id}")
+      response
+    end
+    
+  end
+end

data/lib/youtrack/resources/user.rb

@@ -0,0 +1,14 @@
+module Youtrack
+  class User < Base
+
+
+    # USER Methods
+    def current
+      get('current')
+      response.parsed_response
+    end
+
+    # ADMIN Methods
+
+  end
+end

data/lib/youtrack/version.rb

@@ -1,3 +1,3 @@
 module Youtrack
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/fixtures/login_body_error.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><error>Incorrect login or password.</error>

data/spec/fixtures/login_body_ok.xml

@@ -0,0 +1 @@
+<login>ok</login>

data/spec/fixtures/login_header.json

@@ -0,0 +1,10 @@
+{
+  "Server": "nginx",
+  "Date":  "Fri, 24 Jan 2014 07:49:19 GMT",
+  "Content-Type": "application/xml; charset=UTF-8",
+  "Set-Cookie": "jetbrains.charisma.main.security.PRINCIPAL=NmZkNDc3NDgxZjBhOWNjMTVjNDQwNTljNTE1NzM1ODEwM2I3MjgyMDlkZDAzZGJhYTAzYzU1ZmYyZGUyZWMxNzpyb290;Path=/youtrack;Expires=Sat, 24-Jan-2015 07:49:19 GMT",
+  "Expires": "Thu, 01 Jan 1970 00:00:00 GMT",
+  "Access-Control-Allow-Origin": "chrome-extension://hgmloofddffdnphfgcellkdfbfbjeloo",
+  "Access-Control-Allow-Credentials": "true",
+  "Cache-Control": "no-cache, no-store, no-transform, must-revalidate"
+}

data/spec/spec_helper.rb

@@ -11,6 +11,7 @@ RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
+  config.syntax = :expect
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: youtrack
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - John Faucett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-23 00:00:00.000000000 Z
+date: 2014-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -103,6 +103,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .ruby-gemset
+- .ruby-version
 - .travis.yml
 - Gemfile
 - LICENSE.txt
@@ -115,7 +117,14 @@ files:
 - features/support/world.rb
 - lib/youtrack.rb
 - lib/youtrack/client.rb
+- lib/youtrack/resources/base.rb
+- lib/youtrack/resources/issue.rb
+- lib/youtrack/resources/project.rb
+- lib/youtrack/resources/user.rb
 - lib/youtrack/version.rb
+- spec/fixtures/login_body_error.xml
+- spec/fixtures/login_body_ok.xml
+- spec/fixtures/login_header.json
 - spec/spec_helper.rb
 - youtrack.gemspec
 homepage: ''
@@ -138,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: A Ruby REST API Client for JetBrains youTrack software
@@ -148,4 +157,7 @@ test_files:
 - features/support/env.rb
 - features/support/webmock.rb
 - features/support/world.rb
+- spec/fixtures/login_body_error.xml
+- spec/fixtures/login_body_ok.xml
+- spec/fixtures/login_header.json
 - spec/spec_helper.rb