rally-wsapi 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07d34602eae173bb8a79afe4b517bd834bdba6ac
-  data.tar.gz: 1b4ce42d2bfb6efbad0715ec7cc46e055a526907
+  metadata.gz: 04672bd9cda1627d271b34af07819da21109d52e
+  data.tar.gz: 5134b235bdbccb0730cb1df86751d34fdd79b72b
 SHA512:
-  metadata.gz: 548bb40f0074dfb5ce2f456765d33b0779ece40f189dc906d5209bc027bc2f53a1d37239cbebbbfc948b644dde1adb3ca4765d1a10ca202672e3cd86225d2b00
-  data.tar.gz: 041f1e80d24a43893e1546be46ca3ee0e669718ae0f26b9bc76ed3e2cc2e63bbfb7695be3095bfacdf52a34649529388d196024e81d5d732aab0121db8d4df49
+  metadata.gz: c4e0dcdac647d9b54d4f1aeecbfa31d7f03ea09e4da025a132f4a78511c05514df81fbfcde2755d06acfb1fa398f4b23ba04f8b0d0abec38e530f7cff5b02a7d
+  data.tar.gz: 951d40919c3b1df204ca1a5ca126f27e4694b327a5b4564cea5c7cb2af2d0a6450028d31a7d562538938fd01df4038ff356c046e2244082c4cd4aa3f25cb13b2

data/Gemfile

@@ -12,5 +12,6 @@ end
 
 group :test do
   gem 'rspec'
+  gem 'byebug'
   gem 'webmock'
 end

data/Gemfile.lock

@@ -1,29 +1,32 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.6)
+    addressable (2.4.0)
     builder (3.2.2)
-    crack (0.4.2)
+    byebug (5.0.0)
+      columnize (= 0.9.0)
+    columnize (0.9.0)
+    crack (0.4.3)
       safe_yaml (~> 1.0.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
-    excon (0.42.1)
-    faraday (0.9.0)
+    excon (0.45.4)
+    faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.9.1)
+    faraday_middleware (0.10.0)
       faraday (>= 0.7.4, < 0.10)
-    git (1.2.8)
-    github_api (0.12.2)
-      addressable (~> 2.3)
+    git (1.2.9.1)
+    github_api (0.13.1)
+      addressable (~> 2.4.0)
       descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
-      hashie (>= 3.3)
+      hashie (>= 3.4)
       multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.3)
       oauth2
-    hashie (3.3.2)
-    highline (1.6.21)
+    hashdiff (0.2.3)
+    hashie (3.4.3)
+    highline (1.7.8)
     jeweler (2.0.1)
       builder
       bundler (>= 1.0)
@@ -33,46 +36,49 @@ GEM
       nokogiri (>= 1.5.10)
       rake
       rdoc
-    json (1.8.1)
-    jwt (1.2.0)
-    mini_portile (0.6.2)
-    multi_json (1.10.1)
+    json (1.8.3)
+    jwt (1.5.1)
+    mini_portile2 (2.0.0)
+    multi_json (1.11.2)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    nokogiri (1.6.5)
-      mini_portile (~> 0.6.0)
-    oauth2 (1.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    oauth2 (1.1.0)
       faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
+      jwt (~> 1.0, < 1.5.2)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (~> 1.2)
-    rack (1.6.0)
-    rake (10.4.2)
-    rdoc (4.2.0)
+      rack (>= 1.2, < 3)
+    rack (1.6.4)
+    rake (10.5.0)
+    rdoc (4.2.1)
       json (~> 1.4)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.2)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
     safe_yaml (1.0.4)
-    thread_safe (0.3.4)
-    webmock (1.20.4)
+    thread_safe (0.3.5)
+    webmock (1.22.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug
   excon
   faraday
   faraday_middleware
@@ -83,4 +89,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.10.3
+   1.10.6

data/README.md

@@ -1,6 +1,6 @@
 # rally-wsapi
 
-Rally WSAPI client written in Ruby.
+CA Agile Central (formerly Rally) WSAPI client written in Ruby.
 
 ## Usage
 
@@ -90,9 +90,21 @@ get_team_members(project_id, opts = {})
 get_editors(project_id, opts = {})
 ```
 
-### Update any artifact with parameters hash
+### Update any object with parameters hash
+This method replaces #update_artifact, which has been deprecated.
 ```
-update_artifact(artifact_type, artifact_id, parameters)
+update(object_type, object_id, parameters)
+```
+
+### Create an object with a fields hash
+```
+create(object_type, object_fields)
+```
+
+### Build a wsapi object url
+This URL could be used when associating artifacts in the #create or #update methods
+```
+build_object_url(object_type, object_id)
 ```
 
 ### Setup refresh token to be used with OAuth2

data/Rakefile

@@ -2,11 +2,11 @@ require 'jeweler'
 
 Jeweler::Tasks.new do |s|
   s.name = "rally-wsapi"
-  s.summary = "Simple client for Rally WSAPI"
-  s.email = "antti@flowdock.com"
+  s.summary = "Simple client for CA Agile Central (formerly Rally) WSAPI"
+  s.email = "team@flowdock.com"
   s.homepage = "http://github.com/flowdock/rally-wsapi"
-  s.description = "Simple client for Rally WSAPI"
-  s.authors = ["Antti Pitkänen", "Oskari Virtanen"]
+  s.description = "Simple client for CA Agile Central (formerly Rally) WSAPI"
+  s.authors = ["CA Flowdock"]
   s.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*"]
   s.licenses = ["MIT"]
 end

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.5.2

data/lib/wsapi/session.rb

@@ -44,20 +44,37 @@ module Wsapi
       @conn = connection(session_id)
     end
 
-    def setup_refresh_token(client_id, client_secret, refresh_token, &block)
-      @oauth2 = {
-        client_id: client_id,
-        client_secret: client_secret,
-        refresh_token: refresh_token,
-        refresh_token_updated: block
-      }
+    def build_object_url(type, id)
+      wsapi_resource_url("#{type}/#{id}").sub('userstory', 'hierarchicalrequirement')
     end
 
-    def get_user_subscription
-      response = wsapi_get(wsapi_resource_url("Subscription"))
+    def create(type, fields)
+      response = wsapi_request(:put, wsapi_resource_url("#{type}/create"), type => fields)
+      Mapper.get_object(response)
+    end
+
+    def get_current_user
+      response = wsapi_get(wsapi_resource_url("User"))
+      Mapper.get_object(response)
+    end
+
+    def get_editors(project_id, opts = {})
+      fetch_with_pages(opts) do |page_query|
+        wsapi_get(wsapi_resource_url("Project/#{project_id}/Editors"), opts.merge(page_query))
+      end
+    end
+
+    def get_project(id)
+      response = wsapi_get(wsapi_resource_url("Project/#{id}"))
       Mapper.get_object(response)
     end
 
+    def get_projects(opts = {})
+      fetch_with_pages(opts) do |page_query|
+        wsapi_get(wsapi_resource_url("Project"), opts.merge(page_query))
+      end
+    end
+
     def get_subscription(id)
       response = wsapi_get(wsapi_resource_url("Subscription/#{id}"))
       Mapper.get_object(response)
@@ -68,19 +85,24 @@ module Wsapi
       (Mapper.get_objects(response) ||[]).first
     end
 
-    def get_projects(opts = {})
+    def get_team_members(project_id, opts = {})
       fetch_with_pages(opts) do |page_query|
-        wsapi_get(wsapi_resource_url("Project"), opts.merge(page_query))
+        wsapi_get(wsapi_resource_url("Project/#{project_id}/TeamMembers"), opts.merge(page_query))
       end
     end
 
-    def get_project(id)
-      response = wsapi_get(wsapi_resource_url("Project/#{id}"))
+    def get_user(id)
+      response = wsapi_get(wsapi_resource_url("User/#{id}"))
       Mapper.get_object(response)
     end
 
-    def get_current_user
-      response = wsapi_get(wsapi_resource_url("User"))
+    def get_user_by_username(username)
+      response = wsapi_get(wsapi_resource_url("User"), query: "(UserName = \"#{username}\")", pagesize: 1)
+      (Mapper.get_objects(response) ||[]).first
+    end
+
+    def get_user_subscription
+      response = wsapi_get(wsapi_resource_url("Subscription"))
       Mapper.get_object(response)
     end
 
@@ -95,35 +117,37 @@ module Wsapi
       end
     end
 
-    def get_user(id)
-      response = wsapi_get(wsapi_resource_url("User/#{id}"))
-      Mapper.get_object(response)
-    end
-
-    def get_user_by_username(username)
-      response = wsapi_get(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_get(wsapi_resource_url("Project/#{project_id}/TeamMembers"), opts.merge(page_query))
-      end
+    def setup_refresh_token(client_id, client_secret, refresh_token, &block)
+      @oauth2 = {
+        client_id: client_id,
+        client_secret: client_secret,
+        refresh_token: refresh_token,
+        refresh_token_updated: block
+      }
     end
 
-    def get_editors(project_id, opts = {})
-      fetch_with_pages(opts) do |page_query|
-        wsapi_get(wsapi_resource_url("Project/#{project_id}/Editors"), opts.merge(page_query))
-      end
+    def update(type, id, update_hash)
+      response = wsapi_request(:post, wsapi_resource_url("#{type}/#{id}"), type => update_hash)
+      Mapper.get_object(response)
     end
 
+    # This method is deprecated and will be removed in a future release.
     def update_artifact(type, id, update_hash)
-      response = wsapi_post(wsapi_resource_url("#{type}/#{id}"), "#{type}" => update_hash)
-      Mapper.get_object(response)
+      puts "WsapiAuthentication::Session#update_artifact has been deprecated. Please use #update instead."
+      update(type, id, update_hash)
     end
 
     private
 
+    def check_response_for_errors!(response)
+      raise BadRequestError.new("Bad request", response) if response.status == 400
+      raise AuthorizationError.new("Unauthorized", response) if response.status == 401 || response.status == 403
+      raise ApiError.new("Internal server error", response) if response.status == 500
+      raise ApiError.new("Service unavailable", response) if response.status == 503
+      raise ObjectNotFoundError.new("Object not found") if object_not_found?(response)
+      raise IpAddressLimited.new("IP Address limited", response) if ip_address_limited?(response)
+    end
+
     def connection(session_id)
       Faraday.new(ssl: {version: :TLSv1}) do |faraday|
         faraday.request :json
@@ -132,48 +156,38 @@ module Wsapi
       end
     end
 
-    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_post(url, opts = {})
-      response = wsapi_request_with_refresh_token(:post, url, opts)
-      check_response_for_errors!(response)
-
-      response
+    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
 
-    def wsapi_get(url, opts = {})
-      request_options = {}
-      request_options['workspace'] = workspace_url if @workspace_id
-      request_options['query'] = opts[:query] if opts[:query]
-      request_options['start'] = opts[:start] || 1
-      request_options['pagesize'] = opts[:pagesize] || 200
-      request_options['fetch'] = opts[:fetch] || true # by default, fetch full objects
-
-      response = wsapi_request_with_refresh_token(:get, url, request_options)
-      check_response_for_errors!(response)
-
-      response
+    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 wsapi_request_with_refresh_token(method, url, opts = {})
-      response = @conn.send(method, url, opts) { |req| req.options.timeout = @timeout }
-      if defined?(@oauth2) && response.status == 401
-        refresh_token_response = refresh_token!
-
-        access_token = MultiJson.load(refresh_token_response.body)["access_token"]
-        @conn = connection(access_token)
-        response = @conn.send(method, url, opts) { |req| req.options.timeout = @timeout } # Try again with fresh token
+    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
-
-      response
-    rescue Faraday::TimeoutError
-      raise TimeoutError.new("Request timed out")
     end
 
     def refresh_token!
@@ -202,47 +216,38 @@ module Wsapi
       response
     end
 
-    def check_response_for_errors!(response)
-      raise BadRequestError.new("Bad request", response) if response.status == 400
-      raise AuthorizationError.new("Unauthorized", response) if response.status == 401 || response.status == 403
-      raise ApiError.new("Internal server error", response) if response.status == 500
-      raise ApiError.new("Service unavailable", response) if response.status == 503
-      raise ObjectNotFoundError.new("Object not found") if object_not_found?(response)
-      raise IpAddressLimited.new("IP Address limited", response) if ip_address_limited?(response)
+    def workspace_url
+      wsapi_resource_url("Workspace/#{@workspace_id}")
     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)
+    def wsapi_resource_url(resource)
+      File.join(WSAPI_URL, "v#{@api_version}", resource)
     end
+    
+    def wsapi_get(url, opts = {})
+      request_options = {}
+      request_options['workspace'] = workspace_url if @workspace_id
+      request_options['query'] = opts[:query] if opts[:query]
+      request_options['start'] = opts[:start] || 1
+      request_options['pagesize'] = opts[:pagesize] || 200
+      request_options['fetch'] = opts[:fetch] || true # by default, fetch full objects
 
-    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
+      wsapi_request(:get, url, request_options)
     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]
+    def wsapi_request(method, url, opts = {})
+      response = @conn.send(method, url, opts) { |req| req.options.timeout = @timeout }
+      if defined?(@oauth2) && response.status == 401
+        refresh_token_response = refresh_token!
+
+        access_token = MultiJson.load(refresh_token_response.body)["access_token"]
+        @conn = connection(access_token)
+        response = @conn.send(method, url, opts) { |req| req.options.timeout = @timeout } # Try again with fresh token
       end
-      objects
+      check_response_for_errors!(response)
+      response
+    rescue Faraday::TimeoutError
+      raise TimeoutError.new("Request timed out")
     end
   end
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rally-wsapi
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
-- Antti Pitkänen
-- Oskari Virtanen
+- CA Flowdock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2017-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -81,8 +80,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple client for Rally WSAPI
-email: antti@flowdock.com
+description: Simple client for CA Agile Central (formerly Rally) WSAPI
+email: team@flowdock.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -122,8 +121,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Simple client for Rally WSAPI
+summary: Simple client for CA Agile Central (formerly Rally) WSAPI
 test_files: []