rally-wsapi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8186336211f73579be3d906c7fd2e159636fd23
+  data.tar.gz: f4145b3095c6822f9d7f94d6eb85bd0907b3fdda
+SHA512:
+  metadata.gz: c85d7b133bdd3005a97ba1c07026d6ffa0d7d3cb2e83f8ffb1ad5655b8bf45464bff79c0160c3da47eb05b4bb83fcc2522111f4f056070cfc460f9c59281ba13
+  data.tar.gz: 47334a19d03a163f2aefe565b3c3f21e1c6c6a59d1fb1fa6e96feac91051563c08ca8b4c7ee3cfb67aa896497d061acfb53b8c4441e7fafc9f626a6f132af47e

data/Gemfile

@@ -0,0 +1,12 @@
+gem 'rake'
+gem 'multi_json'
+gem 'faraday'
+
+group :release do
+  gem 'jeweler'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,77 @@
+GEM
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.8)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (3.2.0)
+    highline (1.6.21)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.0.0)
+    mini_portile (0.6.0)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.3.2)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    safe_yaml (1.0.3)
+    thread_safe (0.3.4)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday
+  jeweler
+  multi_json
+  rake
+  rspec
+  webmock

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Flowdock
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+# rally-wsapi
+
+Rally WSAPI client written in Ruby.
+
+## Usage
+
+In order to authenticate to WSAPI, you will need to obtain an API key for the Rally account. This can be done via [Rally OAuth](https://github.com/RallySoftware/rally-oauth-examples), for example.
+
+Once you have the API key, you can initialize the session object with the key:
+```
+s = Wsapi::Session.new("deadbeefdeadbeef")
+```
+
+The constructor also accepts the following options:
+  * `:workspace_id`, if not given, user's default workspace is used for queries
+  * `:version`, WSAPI version, default is `3.0`
+
+
+## Method reference for Session
+
+Some methods accept an optional hash that can have the following options:
+ * `:query`, add conditions for fetching objects. E.g. `(UserName = "John")`, see WSAPI documentation for details about the syntax
+ * `:start`, default: `1`, fetch results starting from given number
+ * `:workspace`, override workspace setting of the session
+ * `:pagesize`, default: `200`, page size for results
+ * `:fetch`, default: `true`, fetch full objects
+
+#### Get the authenticated user
+```
+get_current_user
+```
+
+#### Get a user
+```
+get_user(user_id)
+```
+
+#### Get a user by username
+```
+get_user_by_username(username)
+```
+
+#### Get the subscription of the authenticated user
+```
+get_user_subscription
+```
+
+#### Get a subscription
+```
+get_project(subscription_id)
+```
+
+#### Get a project
+```
+get_project(project_id)
+```
+
+#### Get projects of the authenticated user
+```
+get_projects(opts = {})
+```
+
+#### Get team members in a project
+```
+get_team_members(project_id, opts = {})
+```
+
+#### Get editors in a project
+```
+get_editors(project_id, opts = {})
+```
+
+## Result objects
+
+There's a couple of convenience classes for the following object types:
+
+ * `User`
+ * `Subscription`
+ * `Project`
+
+ Other object types are represented by the generic `Object` class which the specific types above extend.
+
+#### Object
+
+Methods:
+  * `id`, identifier of the object
+  * `name`, name of the object
+  * `url`, URL of the object
+  * `workspace`, name of the object's workspace
+
+
+#### User
+
+Methods:
+  * `username`, username
+  * `first_name`, first name
+  * `last_name`, last name
+  * `name`, full name
+  * `email`, email address
+  * `admin?`, is the user admin in the subscription?
+
+#### Subscription
+
+Methods:
+  * `subscription_id`, subcription identifier
+
+#### Project
+
+Methods:
+  * `subscription`, `Subscription` of the project
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'jeweler'
+
+Jeweler::Tasks.new do |s|
+  s.name = "rally-wsapi"
+  s.summary = "Simple client for Rally WSAPI"
+  s.email = "antti@flowdock.com"
+  s.homepage = "http://github.com/flowdock/rally-wsapi"
+  s.description = "Simple client for Rally WSAPI"
+  s.authors = ["Antti Pitkänen"]
+  s.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*"]
+  s.licenses = ["MIT"]
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/rally-wsapi.rb

@@ -0,0 +1 @@
+require_relative './wsapi/session'

data/lib/wsapi/mapper.rb

@@ -0,0 +1,42 @@
+require 'multi_json'
+
+require_relative './models/object'
+require_relative './models/subscription'
+require_relative './models/user'
+require_relative './models/project'
+
+module Wsapi
+  class Mapper
+    def self.get_errors(json)
+      if result = json["QueryResult"]
+        result["Errors"]
+      elsif result = json["OperationResult"]
+        result["Errors"]
+      else
+        []
+      end
+    end
+
+    def self.get_object(response)
+      json = MultiJson.load(response.body)
+      if get_errors(json).empty? && json.size == 1
+        Wsapi::Object.from_data(json.keys.first, json.values.first)
+      else
+        raise ApiError.new("Errors: #{get_errors(json).inspect}", response)
+      end
+    rescue MultiJson::LoadError
+      raise ApiError.new("Invalid JSON response from WSAPI: #{response.body}", response)
+    end
+
+    def self.get_objects(response)
+      json = MultiJson.load(response.body)
+      if get_errors(json).empty? && query_result = json["QueryResult"]
+        query_result["Results"].map { |object| Wsapi::Object.from_data(object["_type"], object) }
+      else
+        raise ApiError.new("Errors: #{get_errors(json).inspect}", response)
+      end
+    rescue MultiJson::LoadError
+      raise ApiError.new("Invalid JSON response from WSAPI: #{response.body}", response)
+    end
+  end
+end

data/lib/wsapi/models/object.rb

@@ -0,0 +1,33 @@
+module Wsapi
+  class Object
+    attr_reader :raw_data
+
+    def initialize(raw_data)
+      @raw_data = raw_data
+    end
+
+    def name
+      @raw_data['_refObjectName']
+    end
+
+    def id
+      @raw_data['ObjectID']
+    end
+
+    def url
+      @raw_data['_ref']
+    end
+
+    def workspace
+      @raw_data["Workspace"]["_refObjectName"]
+    end
+
+    def self.from_data(type, raw_data)
+      if type && Wsapi.const_defined?(type)
+        Wsapi.const_get(type).new(raw_data)
+      else
+        Object.new(raw_data)
+      end
+    end
+  end
+end

data/lib/wsapi/models/project.rb

@@ -0,0 +1,7 @@
+module Wsapi
+  class Project < Wsapi::Object
+    def subscription
+      @subscription ||= Wsapi::Subscription.new(@raw_data["Subscription"])
+    end
+  end
+end

data/lib/wsapi/models/subscription.rb

@@ -0,0 +1,7 @@
+module Wsapi
+  class Subscription < Wsapi::Object
+    def subscription_id
+      @raw_data["SubscriptionID"].to_s
+    end
+  end
+end

data/lib/wsapi/models/user.rb

@@ -0,0 +1,27 @@
+module Wsapi
+  class User < Wsapi::Object
+    def username
+      @raw_data["UserName"]
+    end
+
+    def first_name
+      @raw_data["FirstName"]
+    end
+
+    def last_name
+      @raw_data["LastName"]
+    end
+
+    def name
+      "#{@raw_data['FirstName']} #{@raw_data['LastName']}"
+    end
+
+    def email
+      @raw_data["EmailAddress"]
+    end
+
+    def admin?
+      @raw_data["SubscriptionAdmin"]
+    end
+  end
+end

data/lib/wsapi/session.rb

@@ -0,0 +1,156 @@
+require 'multi_json'
+require 'faraday'
+
+require_relative './mapper'
+
+module Wsapi
+  class StandardErrorWithResponse < StandardError
+    attr_reader :response
+    def initialize(msg, response = nil)
+      @response = response
+      super(msg)
+    end
+  end
+  class AuthorizationError < StandardErrorWithResponse; end
+  class ApiError < StandardErrorWithResponse; end
+  class ObjectNotFoundError < StandardErrorWithResponse; end
+  class IpAddressLimited < StandardErrorWithResponse; end
+
+  WSAPI_URL = ENV['WSAPI_URL'] || 'https://rally1.rallydev.com/slm/webservice/'
+
+  class WsapiAuthentication < Faraday::Middleware
+    def initialize(logger, session_id)
+      @session_id = session_id
+      super(logger)
+    end
+
+    def call(env)
+      env[:request_headers]['ZSESSIONID'] = @session_id
+      @app.call(env)
+    end
+  end
+
+  class Session
+    attr_accessor :workspace_id
+
+    def initialize(session_id, opts = {})
+      @api_version = opts[:version] || "3.0"
+      @session_id = session_id
+      @workspace_id = opts[:workspace_id]
+      @conn = Faraday.new(ssl: { verify: false} ) do |faraday|
+        faraday.request  :url_encoded # form-encode POST params
+        faraday.use WsapiAuthentication, @session_id
+        faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
+      end
+    end
+
+    def get_user_subscription
+      response = wsapi_request(wsapi_resource_url("Subscription"))
+      Mapper.get_object(response)
+    end
+
+    def get_subscription(id)
+      response = wsapi_request(wsapi_resource_url("Subscription/#{id}"))
+      Mapper.get_object(response)
+    end
+
+    def get_projects(opts = {})
+      fetch_with_pages(opts) do |page_query|
+        wsapi_request(wsapi_resource_url("Project"), opts.merge(page_query))
+      end
+    end
+
+    def get_project(id)
+      response = wsapi_request(wsapi_resource_url("Project/#{id}"))
+      Mapper.get_object(response)
+    end
+
+    def get_current_user
+      response = wsapi_request(wsapi_resource_url("User"))
+      Mapper.get_object(response)
+    end
+
+    def get_user(id)
+      response = wsapi_request(wsapi_resource_url("User/#{id}"))
+      Mapper.get_object(response)
+    end
+
+    def get_user_by_username(username)
+      response = wsapi_request(wsapi_resource_url("User"), query: "(UserName = \"#{username}\")", pagesize: 1)
+      (Mapper.get_objects(response) ||[]).first
+    end
+
+    def get_team_members(project_id, opts = {})
+      fetch_with_pages(opts) do |page_query|
+        wsapi_request(wsapi_resource_url("Project/#{project_id}/TeamMembers"), opts.merge(page_query))
+      end
+    end
+
+    def get_editors(project_id, opts = {})
+      fetch_with_pages(opts) do |page_query|
+        wsapi_request(wsapi_resource_url("Project/#{project_id}/Editors"), opts.merge(page_query))
+      end
+    end
+
+    private
+
+    def workspace_url
+      wsapi_resource_url("Workspace/#{@workspace_id}")
+    end
+
+    def wsapi_resource_url(resource)
+      File.join(WSAPI_URL, "v#{@api_version}", resource)
+    end
+
+    def wsapi_request(url, opts = {})
+      response = @conn.get do |req|
+        req.url url
+        req.params['workspace'] = workspace_url if @workspace_id
+        req.params['query'] = opts[:query] if opts[:query]
+        req.params['start'] = opts[:start] || 1
+        req.params['pagesize'] = opts[:pagesize] || 200
+        req.params['fetch'] = opts[:fetch] || true # by default, fetch full objects
+      end
+      raise AuthorizationError.new("Unauthorized", response) if response.status == 401
+      raise ApiError.new("Internal server error", response) if response.status == 500
+      raise ObjectNotFoundError.new("Object not found") if object_not_found?(response)
+      raise IpAddressLimited.new("IP Address limited", response) if ip_address_limited?(response)
+      response
+    end
+
+    def ip_address_limited?(response)
+      limit_message = /Your IP address, (?:\d+\.?)+, is not within the allowed range that your subscription administrator has configured./
+      response.status > 401 && response.body.match(limit_message)
+    end
+
+    def object_not_found?(response)
+      if response.status == 200
+        result = MultiJson.load(response.body)["OperationResult"]
+        if result && error = result["Errors"].first
+          error.match("Cannot find object to read")
+        else
+          false
+        end
+      else
+        false
+      end
+    end
+
+    def fetch_with_pages(opts = {}, &block)
+      page_query = {
+        start: opts[:start] || 1,
+        pagesize: opts[:pagesize] || 100
+      }
+      resultCount = nil
+      objects = []
+      while(!resultCount || resultCount > objects.size) do
+        response = yield(page_query)
+        resultCount = MultiJson.load(response.body)["QueryResult"]["TotalResultCount"]
+        objects += Mapper.get_objects(response)
+        page_query[:start] += page_query[:pagesize]
+      end
+      objects
+    end
+  end
+end
+

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rally-wsapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Antti Pitkänen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple client for Rally WSAPI
+email: antti@flowdock.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/rally-wsapi.rb
+- lib/wsapi/mapper.rb
+- lib/wsapi/models/object.rb
+- lib/wsapi/models/project.rb
+- lib/wsapi/models/subscription.rb
+- lib/wsapi/models/user.rb
+- lib/wsapi/session.rb
+homepage: http://github.com/flowdock/rally-wsapi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Simple client for Rally WSAPI
+test_files: []