cdd 0.0.2 → 0.0.3

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+test-script.rb

data/.travis.yml

@@ -0,0 +1,2 @@
+script:
+  - bundle exec rake spec

data/README.md

@@ -1,7 +1,9 @@
-# CDD - Collaborative Drug Discovery
+# CDD - Collaborative Drug Discovery [![Build Status](https://travis-ci.org/cpetersen/cdd.png?branch=master)](https://travis-ci.org/cpetersen/cdd) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/cpetersen/cdd)
 
 Collaborative Drug Discovery is a web based tool for storing and sharing pharmaceutical research. This is a ruby wrapper for their API.
 
+CDD's API can be found [here](https://support.collaborativedrug.com/categories/20081556-cdd-api-documentation).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -48,6 +50,17 @@ Returns a list of project objects that look like:
 [{"name"=>"Your Project Name", "id"=>1234}]
 ```
 
+## DataSets
+Given a vault object, you can retrieve it's available data sets:
+```ruby
+data_sets = vaults.first.data_sets
+```
+
+Returns a list of data_set objects that look like:
+```ruby
+[{"name"=>"Data Set X, "id"=>1234567}]
+```
+
 ## Searches
 Given a vault object, you can retrieve it's searches list:
 ```ruby

data/lib/cdd/data_set.rb

@@ -0,0 +1,6 @@
+module CDD
+  class DataSet < Base
+    attr_accessor :name
+    attr_accessor :vault
+  end
+end

data/lib/cdd/vault.rb

@@ -2,6 +2,16 @@ module CDD
   class Vault < Base
     attr_accessor :name
 
+    def data_sets
+      @data_sets ||= client.execute(data_sets_url).collect do |hash|
+        CDD::DataSet.new(self.client, {:vault => self}.merge(hash))
+      end
+    end
+
+    def data_sets_url
+      "/api/v1/vaults/#{self.id}/data_sets"
+    end
+
     def projects
       @project ||= client.execute(projects_url).collect do |hash|
         CDD::Project.new(self.client, {:vault => self}.merge(hash))

data/lib/cdd/version.rb

@@ -1,3 +1,3 @@
 module CDD
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/cdd.rb

@@ -1,5 +1,6 @@
 require "cdd/base"
 require "cdd/client"
+require "cdd/data_set"
 require "cdd/export"
 require "cdd/project"
 require "cdd/search"

data/spec/cdd_spec.rb

@@ -1,109 +1,136 @@
 require 'spec_helper'
 
 describe CDD do
-
   context "A default client" do
-    context "when requesting vaults" do
-      let(:token) { ENV["CDD_TOKEN_ID"] || "1234567890" }
-      let(:client) { CDD::Client.new(token) }
+    let(:token) { ENV["CDD_TOKEN_ID"] || "1234567890" }
+    let(:client) { CDD::Client.new(token) }
+
+    it "should have the correct vaults_url" do
+      client.vaults_url.should == "/api/v1/vaults"
+    end
 
-      it "should have the correct vaults_url" do
-        client.vaults_url.should == "/api/v1/vaults"
+    it "should call the default vaults url" do
+      RestClient.should_receive(:get).with("https://app.collaborativedrug.com/api/v1/vaults", { :params=>{} , "X-CDD-Token" => token}).and_return(fake_response([{:id => "1234", :name => "Test Vault"}].to_json))
+      client.vaults
+    end
+
+    context "when requesting vaults" do
+      before(:all) do
+        RestClient.stub(:get).with("https://app.collaborativedrug.com/api/v1/vaults", { :params=>{} , "X-CDD-Token" => token}).and_return(fake_response([{:id => "1234", :name => "Test Vault"}].to_json))
       end
+      let(:vaults) { client.vaults }
 
-      it "should call the default vaults url" do
-        RestClient.should_receive(:get).with("https://app.collaborativedrug.com/api/v1/vaults", { :params=>{} , "X-CDD-Token" => token}).and_return(fake_response([{:id => "1234", :name => "Test Vault"}].to_json))
-        client.vaults
+      it "should return an array of vaults" do
+        vaults.class.should == Array
+        vaults.first.class.should == CDD::Vault
       end
 
-      context "when requesting vaults" do
-        before(:all) do
-          RestClient.stub(:get).with("https://app.collaborativedrug.com/api/v1/vaults", { :params=>{} , "X-CDD-Token" => token}).and_return(fake_response([{:id => "1234", :name => "Test Vault"}].to_json))
+      context "the vault" do
+        let(:vault) { vaults.first }
+
+        it "should have the correct values" do
+          vault.id.should == "1234"
+          vault.name.should == "Test Vault"
         end
-        let(:vaults) { client.vaults }
 
-        it "should return an array of vaults" do
-          vaults.class.should == Array
-          vaults.first.class.should == CDD::Vault
+        it "should have the correct default export_url" do
+          vault.export_url.should == "/api/v1/vaults/#{vault.id}/exports.csv"
         end
 
-        context "the vault" do
-          let(:vault) { vaults.first }
+        it "should have the correct csv export_url" do
+          vault.export_url("csv").should == "/api/v1/vaults/#{vault.id}/exports.csv"
+        end
 
-          it "should have the correct values" do
-            vault.id.should == "1234"
-            vault.name.should == "Test Vault"
-          end
+        it "should have the correct sdf export_url" do
+          vault.export_url("sdf").should == "/api/v1/vaults/#{vault.id}/exports.sdf"
+        end
 
-          it "should have the correct default export_url" do
-            vault.export_url.should == "/api/v1/vaults/#{vault.id}/exports.csv"
-          end
+        it "should have the correct searches_url" do
+          vault.searches_url.should == "/api/v1/vaults/#{vault.id}/searches"
+        end
 
-          it "should have the correct csv export_url" do
-            vault.export_url("csv").should == "/api/v1/vaults/#{vault.id}/exports.csv"
-          end
+        it "should call the default searches url" do
+          RestClient.should_receive(:get).with("https://app.collaborativedrug.com/api/v1/vaults/#{vault.id}/searches", { :params=>{} , "X-CDD-Token" => token}).and_return(fake_response([{:id => "12345", :name => "Test Search"}].to_json))
+          vault.searches
+        end
 
-          it "should have the correct sdf export_url" do
-            vault.export_url("sdf").should == "/api/v1/vaults/#{vault.id}/exports.sdf"
+        context "when requesting searches" do
+          before(:all) do
+            RestClient.stub(:get).with("https://app.collaborativedrug.com/api/v1/vaults/#{vault.id}/searches", { :params=>{} , "X-CDD-Token" => token}).and_return(fake_response([{:id => "12345", :name => "Test Search"}].to_json))
           end
+          let(:searches) { vault.searches }
 
-          it "should have the correct searches_url" do
-            vault.searches_url.should == "/api/v1/vaults/#{vault.id}/searches"
+          it "should return an array of searches" do
+            searches.class.should == Array
+            searches.first.class.should == CDD::Search
           end
 
-          it "should call the default searches url" do
-            RestClient.should_receive(:get).with("https://app.collaborativedrug.com/api/v1/vaults/#{vault.id}/searches", { :params=>{} , "X-CDD-Token" => token}).and_return(fake_response([{:id => "12345", :name => "Test Search"}].to_json))
-            vault.searches
-          end
+          context "the search" do
+            let(:search) { searches.first }
 
-          context "when requesting searches" do
-            before(:all) do
-              RestClient.stub(:get).with("https://app.collaborativedrug.com/api/v1/vaults/#{vault.id}/searches", { :params=>{} , "X-CDD-Token" => token}).and_return(fake_response([{:id => "12345", :name => "Test Search"}].to_json))
+            it "should have the correct values" do
+              search.id.should == "12345"
+              search.name.should == "Test Search"
             end
-            let(:searches) { vault.searches }
+          end
+        end
 
-            it "should return an array of searches" do
-              searches.class.should == Array
-              searches.first.class.should == CDD::Search
-            end
+        it "should have the correct data_sets_url" do
+          vaults.first.data_sets_url.should == "/api/v1/vaults/#{vaults.first.id}/data_sets"
+        end
 
-            context "the search" do
-              let(:search) { searches.first }
+        it "should call the default data_sets url" do
+          RestClient.should_receive(:get).with("https://app.collaborativedrug.com/api/v1/vaults/#{vaults.first.id}/data_sets", { :params=>{} , "X-CDD-Token" => token}).and_return(fake_response([{:id => "12345678", :name => "Test Data Set"}].to_json))
+          vault.data_sets
+        end
 
-              it "should have the correct values" do
-                search.id.should == "12345"
-                search.name.should == "Test Search"
-              end
-            end
+        context "when requesting data_sets" do
+          before(:all) do
+            RestClient.stub(:get).with("https://app.collaborativedrug.com/api/v1/vaults/#{vaults.first.id}/data_sets", { :params=>{} , "X-CDD-Token" => token}).and_return(fake_response([{:id => "12345678", :name => "Test Data Set"}].to_json))
           end
+          let(:data_sets) { vault.data_sets }
 
-          it "should have the correct projects_url" do
-            vaults.first.projects_url.should == "/api/v1/vaults/#{vaults.first.id}/projects"
+          it "should return an array of data_sets" do
+            data_sets.class.should == Array
+            data_sets.first.class.should == CDD::DataSet
           end
 
-          it "should call the default projects url" do
-            RestClient.should_receive(:get).with("https://app.collaborativedrug.com/api/v1/vaults/#{vaults.first.id}/projects", { :params=>{} , "X-CDD-Token" => token}).and_return(fake_response([{:id => "123456", :name => "Test Project"}].to_json))
-            vault.projects
-          end
+          context "the data_set" do
+            let(:data_set) { data_sets.first }
 
-          context "when requesting projects" do
-            before(:all) do
-              RestClient.stub(:get).with("https://app.collaborativedrug.com/api/v1/vaults/#{vaults.first.id}/projects", { :params=>{} , "X-CDD-Token" => token}).and_return(fake_response([{:id => "123456", :name => "Test Project"}].to_json))
+            it "should have the correct values" do
+              data_set.id.should == "12345678"
+              data_set.name.should == "Test Data Set"
             end
-            let(:projects) { vault.projects }
+          end
+        end
 
-            it "should return an array of projects" do
-              projects.class.should == Array
-              projects.first.class.should == CDD::Project
-            end
+        it "should have the correct projects_url" do
+          vaults.first.projects_url.should == "/api/v1/vaults/#{vaults.first.id}/projects"
+        end
+
+        it "should call the default projects url" do
+          RestClient.should_receive(:get).with("https://app.collaborativedrug.com/api/v1/vaults/#{vaults.first.id}/projects", { :params=>{} , "X-CDD-Token" => token}).and_return(fake_response([{:id => "123456", :name => "Test Project"}].to_json))
+          vault.projects
+        end
+
+        context "when requesting projects" do
+          before(:all) do
+            RestClient.stub(:get).with("https://app.collaborativedrug.com/api/v1/vaults/#{vaults.first.id}/projects", { :params=>{} , "X-CDD-Token" => token}).and_return(fake_response([{:id => "123456", :name => "Test Project"}].to_json))
+          end
+          let(:projects) { vault.projects }
+
+          it "should return an array of projects" do
+            projects.class.should == Array
+            projects.first.class.should == CDD::Project
+          end
 
-            context "the project" do
-              let(:project) { projects.first }
+          context "the project" do
+            let(:project) { projects.first }
 
-              it "should have the correct values" do
-                project.id.should == "123456"
-                project.name.should == "Test Project"
-              end
+            it "should have the correct values" do
+              project.id.should == "123456"
+              project.name.should == "Test Project"
             end
           end
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cdd
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-19 00:00:00.000000000 Z
+date: 2013-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -83,6 +83,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -91,6 +92,7 @@ files:
 - lib/cdd.rb
 - lib/cdd/base.rb
 - lib/cdd/client.rb
+- lib/cdd/data_set.rb
 - lib/cdd/export.rb
 - lib/cdd/project.rb
 - lib/cdd/search.rb
@@ -112,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3887554079488693763
+      hash: 3574982497320562979
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -121,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3887554079488693763
+      hash: 3574982497320562979
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24