ruby_tfs 0.0.2 → 0.0.3

data/lib/tfs/builds.rb

@@ -23,8 +23,8 @@ module TFS
       #
       def find(definition, project, number)
         begin
-          TFS.builds("Definition='#{definition}',Project='#{project}',Number='#{number}'").run.first
-        rescue RestClient::BadRequest => e
+          TFS.builds(definition: definition, project: project, number: number).run.first
+        rescue RestClient::ResourceNotFound => e
           raise Queryable::RecordNotFound, "No record found for '#{definition}', '#{project}', #{number}"
         end
       end

data/lib/tfs/changes.rb

@@ -0,0 +1,19 @@
+module TFS
+  class Changes < Queryable
+
+    class << self
+      # Changes have to be scoped by changesets, so all requires we have a changeset id
+      def all(changeset)
+        TFS.changesets(changeset).changes
+      end
+
+      # Change can be found by changeset and path
+      #
+      #     TFS::Changes.find(123, '/path/to/change')
+      #
+      def find(changeset, path)
+        TFS.changes({changeset: changeset, path: path}).run.first
+      end
+    end
+  end
+end

data/lib/tfs/changesets.rb

@@ -1,5 +1,9 @@
+require 'tfs/changes'
+
 module TFS
   class Changesets < Queryable
+    add_child TFS::Changes
+
     class << self
       # Changeset can be found by id alone
       #

data/lib/tfs/client.rb

@@ -23,10 +23,10 @@ module TFS
 
     # Creates the connection to the data provider source
     def connect
-      @connection = @provider.new endpoint, opts_for_connection
+      @connection ||= @provider.new endpoint, opts_for_connection
     end
 
-    [TFS::Builds, TFS::Changesets, TFS::Projects, TFS::WorkItems].each do |klass|
+    TFS::QueryEngine::VALID_CLASSES.each do |klass|
       define_method(base_class(klass).downcase) do |*params|
         TFS::QueryEngine.new(klass, @connection, params)
       end

data/lib/tfs/query_engine.rb

@@ -1,6 +1,7 @@
 require 'tfs/queryable'
 require 'tfs/builds'
 require 'tfs/changesets'
+require 'tfs/changes'
 require 'tfs/projects'
 
 require 'tfs/work_items'
@@ -12,15 +13,25 @@ module TFS
 
     attr_reader :type
 
+
+    # Classes we currently support queries on
     VALID_CLASSES = [
       TFS::Builds,
       TFS::Changesets,
       TFS::Projects,
-      TFS::WorkItems
+      TFS::WorkItems,
+      TFS::Changes
     ]
 
+    # Default pagination `#all` limit
+    # for all other actions, it limits by default to 20 (API level limit)
     DEFAULT_LIMIT = 50
 
+    # A new query requres a base class (of one of the above `VALID_CLASSES`),
+    # a connection (from `client.connection`) and can take additional selection parameters
+    #
+    #     TFS::QueryEngine(TFS::Projects, TFS.client.connection, 'project-name')
+    #
     def initialize(for_class, connection, params="")
       check_type(for_class)
       @type, @connection = for_class, connection
@@ -28,45 +39,48 @@ module TFS
       @native_query = @connection.send(base_class(for_class), normalize(params))
     end
 
+    # Returns the underlying `OData::QueryBuilder` object in case you want to work
+    # directly against the odata adapter
     def raw
       @native_query
     end
 
+    # Limit records returned
     def limit(count)
       @native_query = @native_query.top(count)
       self
     end
 
+    # Ordering. Must be a valid field
     def order_by(query)
       @native_query = @native_query.order_by(query)
       self
     end
 
+    # Filtering, use odata query syntax
     def where(filter)
       @native_query = @native_query.filter(filter)
       self
     end
 
+    # Return a count of records rather than records
     def count
       @native_query = @native_query.count
       self
     end
 
-    def include(klass)
-      check_type(klass)
-      @native_query.expand(base_class(klass))
-      self
-    end
-
+    # For pagination. Skips supplied number of records
     def page(start)
       @native_query = @native_query.skip(start)
       self
     end
 
+    # Required to execute the query
     def run
       @connection.execute
     end
 
+    # Returns the actual query string (does not run query)
     def to_query
       @native_query.query
     end

data/ruby_tfs.gemspec

@@ -19,5 +19,5 @@ Gem::Specification.new do |spec|
   spec.required_rubygems_version = '>= 1.3.6'
   spec.summary = spec.description
   spec.test_files = Dir.glob("spec/**/*")
-  spec.version = "0.0.2"
+  spec.version = "0.0.3"
 end

data/spec/fixtures/cassettes/builds.yml

@@ -448,4 +448,50 @@ http_interactions:
         syntax.</message>\r\n</error>"
     http_version: 
   recorded_at: Wed, 06 Mar 2013 21:02:55 GMT
+- request:
+    method: get
+    uri: https://snd%5Cplukevdh_cp:garbage@codeplexodata.cloudapp.net/TFS29/Builds(Definition='rubytfs_demo',Project='rubytfs',Number='1')
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Cache-Control:
+      - private
+      Content-Length:
+      - '246'
+      Content-Type:
+      - application/xml
+      Expires:
+      - Wed, 06 Mar 2013 22:06:55 GMT
+      Vary:
+      - ! '*'
+      Server:
+      - Microsoft-IIS/7.0
+      Dataserviceversion:
+      - 1.0;
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Wed, 06 Mar 2013 22:06:34 GMT
+    body:
+      encoding: US-ASCII
+      string: ! "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>\r\n<error
+        xmlns=\"http://schemas.microsoft.com/ado/2007/08/dataservices/metadata\">\r\n
+        \ <code></code>\r\n  <message xml:lang=\"en-US\">Resource not found for the
+        segment 'Builds'.</message>\r\n</error>"
+    http_version: 
+  recorded_at: Wed, 06 Mar 2013 22:06:34 GMT
 recorded_with: VCR 2.4.0

data/spec/tfs/query_engine_spec.rb

@@ -25,18 +25,6 @@ describe TFS::QueryEngine do
     query.limit(10).order_by("Reason")
   end
 
-  it "can include other results" do
-    native_query.should_receive(:expand).with('Changesets').and_return(native_query).once
-
-    query.include(TFS::Changesets)
-  end
-
-  it "raises error if expand by invalid class" do
-    expect { query.include('String') }.to raise_error(TypeError)
-
-    native_query.should_not have_received(:expand)
-  end
-
   it "can cause pagination" do
     native_query.should_receive(:skip).with(10)
     query.page(10)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_tfs
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -55,6 +55,7 @@ files:
 - README.md
 - ruby_tfs.gemspec
 - lib/tfs/builds.rb
+- lib/tfs/changes.rb
 - lib/tfs/changesets.rb
 - lib/tfs/class_helpers.rb
 - lib/tfs/client.rb
@@ -95,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1497286173893304256
+      hash: -1238616650401436106
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: