assaydepot 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in assaydepot.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Christopher Petersen
+
+MIT License
+
+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,64 @@
+# AssayDepot
+
+Ruby interface for Assay Depot's online laboratory (http://www.assaydepot.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'assaydepot'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install assaydepot
+
+## Basic Usage
+
+```ruby
+require 'assaydepot'
+AssayDepot.configure do |config|
+  config.auth_token = "1234567890"
+  config.url = "http://localhost:3000/api"
+end
+wares = AssayDepot::Ware.find("Antibody")
+wares.total
+```
+
+## Using Facets
+
+```ruby
+wares = AssayDepot::Ware.where(:ware_type => "CustomService")
+wares.facets
+```
+
+## Chainable Commands
+
+```ruby
+wares = AssayDepot::Ware.where(:ware_type => "CustomService").where(:available_provider_names => "Assay Depot").page(2)
+wares.first["name"]
+```
+
+## Providers
+
+```ruby
+providers = AssayDepot::Provider.where(:starts_with => "a").per_page(600)
+providers.count
+```
+
+## Get Details
+```ruby
+providers = AssayDepot::Provider.where(:starts_with => "a")
+AssayDepot::Provider.get(providers.first["id"])
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/assaydepot.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/assaydepot/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Christopher Petersen"]
+  gem.email         = ["christopher.petersen@gmail.com"]
+  gem.description   = %q{This is the first version of Assay Depot's Ruby SDK. It provides read access to Services and Vendors through assaydepot.com's JSON API.}
+  gem.summary       = %q{Provides read access to Assay Depot's Services and Vendors.}
+  gem.homepage      = "https://github.com/assaydepot/assaydepot-rb"
+
+  gem.add_dependency('json')
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "assaydepot"
+  gem.require_paths = ["lib"]
+  gem.version       = AssayDepot::VERSION
+end

data/lib/assaydepot.rb

@@ -0,0 +1,26 @@
+require "assaydepot/version"
+require "assaydepot/configurable"
+require "assaydepot/client"
+require "assaydepot/model"
+require "assaydepot/ware"
+require "assaydepot/provider"
+
+# Twitter.configure do |config|
+#   config.consumer_key = YOUR_CONSUMER_KEY
+#   config.consumer_secret = YOUR_CONSUMER_SECRET
+#   config.oauth_token = YOUR_OAUTH_TOKEN
+#   config.oauth_token_secret = YOUR_OAUTH_TOKEN_SECRET
+# end
+
+module AssayDepot
+  class << self
+    include AssayDepot::Configurable
+  end
+
+  # Delegate to a AssayDepot::Client
+  #
+  # @return [AssayDepot::Client]
+  def client
+    AssayDepot::Client.new(options)
+  end
+end

data/lib/assaydepot/client.rb

@@ -0,0 +1,32 @@
+require "open-uri"
+require "json"
+
+module AssayDepot
+  class Client    
+    def initialize(options={})
+      @search_type = options[:search_type] || "wares"
+    end
+
+    def search_url(query, facets, params={})
+      "#{AssayDepot.url}/#{@search_type}.json?#{params.collect { |k,v| "#{k}=#{v.to_s.gsub(" ","+")}"}.join("&")}"
+    end
+
+    def get_url(id, params={})
+      "#{AssayDepot.url}/#{@search_type}/#{id}.json?#{params.collect { |k,v| "#{k}=#{v.to_s.gsub(" ","+")}"}.join("&")}"
+    end
+
+    def search(query, facets, params={})
+      params["auth_token"] = AssayDepot.auth_token
+      params["q"] = query
+      facets.map do |name,value|
+        params["facets[#{name}][]"] = value
+      end
+      JSON.parse(open(search_url(query, facets, params)).read)
+    end
+
+    def get(id, params={})
+      params["auth_token"] = AssayDepot.auth_token
+      JSON.parse(open(get_url(id, params)).read)
+    end
+  end
+end

data/lib/assaydepot/configurable.rb

@@ -0,0 +1,22 @@
+module AssayDepot
+  module Configurable
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+      self
+    end
+
+    CONFIG_KEYS = [
+      :url,
+      :auth_token,
+    ] unless defined? CONFIG_KEYS
+    attr_accessor *CONFIG_KEYS
+
+    class << self
+      def keys
+        @keys ||= CONFIG_KEYS
+      end
+    end
+  end
+end

data/lib/assaydepot/model.rb

@@ -0,0 +1,109 @@
+module AssayDepot
+  module Model
+    module ClassMethods
+      def find(query)
+        self.new.find(query)
+      end
+      def where(conditions={})
+        self.new.where(conditions)
+      end
+      def get(id)
+        Client.new(:search_type => search_type).get(id)
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+      base.extend Forwardable
+      base.def_delegators  :private_results, 
+                      :each, 
+                      :[], 
+                      :count, 
+                      :collect, 
+                      :map,
+                      :tap, 
+                      :<=>, 
+                      :compact, 
+                      :each_index, 
+                      :each_with_index, 
+                      :empty?, 
+                      :flatten, 
+                      :include?, 
+                      :index, 
+                      :length, 
+                      :first, 
+                      :last, 
+                      :keep_if,
+                      :reject,
+                      :reverse
+
+      attr_accessor :search_query
+      attr_accessor :search_facets
+      attr_accessor :search_options
+
+      def initialize(options={})
+        @search_query = options[:search_query] || ""
+        @search_facets = options[:search_facets] || {}
+        @search_options = options[:search_options] || {:page => 1}
+      end
+
+      def initialize_copy(source)  
+        super
+        @search_query = @search_query.dup
+        @search_facets = @search_facets.dup
+      end
+
+      def query_time
+        search_results["query_time"]
+      end
+      def total
+        search_results["total"]
+      end
+      def page
+        search_results["page"]
+      end
+      def per_page
+        search_results["per_page"]
+      end
+      def facets
+        search_results["facets"]
+      end
+
+      def page(page_num)
+        options( { "page" => page_num } )
+      end
+
+      def per_page(page_size)
+        options( { "per_page" => page_size } )
+      end
+
+      def find(query)
+        result = self.clone
+        result.search_query = search_query
+        result
+      end
+
+      def where(conditions={})
+        result = self.clone
+        result.search_facets = self.search_facets ? self.search_facets.merge(conditions) : conditions
+        result
+      end
+
+      def options(options={})
+        result = self.clone
+        result.search_options = self.search_options ? self.search_options.merge(options) : options
+        result
+      end
+
+      def private_results
+        search_results[self.class.ref_name]
+      end
+      def search_results
+        unless @search_results
+          @search_results = Client.new(:search_type => self.class.search_type).search(search_query, search_facets, search_options)
+        end
+        @search_results
+      end
+    end
+  end
+end

data/lib/assaydepot/provider.rb

@@ -0,0 +1,12 @@
+module AssayDepot
+  class Provider
+    include Model
+
+    def self.search_type
+      "providers"
+    end
+    def self.ref_name
+      "provider_refs"
+    end
+  end
+end

data/lib/assaydepot/version.rb

@@ -0,0 +1,3 @@
+module AssayDepot
+  VERSION = "0.0.1"
+end

data/lib/assaydepot/ware.rb

@@ -0,0 +1,12 @@
+module AssayDepot
+  class Ware
+    include Model
+
+    def self.search_type
+      "wares"
+    end
+    def self.ref_name
+      "ware_refs"
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: assaydepot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christopher Petersen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is the first version of Assay Depot's Ruby SDK. It provides read
+  access to Services and Vendors through assaydepot.com's JSON API.
+email:
+- christopher.petersen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- assaydepot.gemspec
+- lib/assaydepot.rb
+- lib/assaydepot/client.rb
+- lib/assaydepot/configurable.rb
+- lib/assaydepot/model.rb
+- lib/assaydepot/provider.rb
+- lib/assaydepot/version.rb
+- lib/assaydepot/ware.rb
+homepage: https://github.com/assaydepot/assaydepot-rb
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides read access to Assay Depot's Services and Vendors.
+test_files: []