fluidinfo 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "rest-client"
+gem "json"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.1)
+    mime-types (1.16)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  json
+  rcov
+  rest-client
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Eric Seidel
+
+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.rdoc

@@ -0,0 +1,30 @@
+= fluidinfo
+
+Fluidinfo.rb provides a simple interface to fluidinfo.
+
+== Simple Example
+
+ >> require 'fluidinfo'
+ >> fluid = Fluidinfo::Client.new
+ >> fluid.get '/objects', :query => 'has gridaphobe/met'
+ => {"ids"=>["fa0bb30b-d1c2-4438-b65c-d86bbb1a44cd"]}
+
+For now, check out Fluidinfo's extensive 
+{documentation}[http://api.fluidinfo.com/] for explanations of each API call.
+
+
+== Contributing to fluidinfo
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Eric Seidel. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fluidinfo"
+  gem.homepage = "http://github.com/gridaphobe/fluidinfo"
+  gem.license = "MIT"
+  gem.summary = %Q{Provides a simple interface to fluidinfo}
+  gem.description = %Q{This gem provides a simple interface to fluidinfo, built on top of the rest-client gem.}
+  gem.email = "gridaphobe@gmail.com"
+  gem.authors = ["Eric Seidel"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_runtime_dependency "rest-client"
+  gem.add_runtime_dependency "json"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fluidinfo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/fluidinfo.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fluidinfo}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eric Seidel"]
+  s.date = %q{2011-03-22}
+  s.description = %q{This gem provides a simple interface to fluidinfo, built on top of the rest-client gem.}
+  s.email = %q{gridaphobe@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "fluidinfo.gemspec",
+    "lib/fluidinfo.rb",
+    "test/helper.rb",
+    "test/test_fluidinfo.rb"
+  ]
+  s.homepage = %q{http://github.com/gridaphobe/fluidinfo}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Provides a simple interface to fluidinfo}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_fluidinfo.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end
+

data/lib/fluidinfo.rb

@@ -0,0 +1,121 @@
+require "rest-client"
+require "uri"
+require "json"
+require "base64"
+
+module Fluidinfo
+  class Client
+    # The main fluidinfo instance.
+    @@MAIN    = 'https://fluiddb.fluidinfo.com'
+    # The sandbox instance, test your code here.
+    @@SANDBOX = 'https://sandbox.fluidinfo.com'
+    
+    def initialize(options={})
+      if options[:sandbox]
+        @instance = @@SANDBOX
+      else
+        @instance = @@MAIN
+      end
+      @headers = {
+        "Accept" => "*/*"
+      }
+    end
+
+    def login(user, pass)
+      auth = "Basic " + (Base64.encode64 "#{user}:#{pass}").strip
+      @headers["Authorization"] = auth
+    end
+
+    def logout
+      @headers.delete "Authorization"
+    end
+
+    # Call GET
+    def get(path, options={})
+      path = @instance + path
+      args = ''
+      options.each do |key, val|
+        if key == :tags
+          val.each do |tag|
+            args += "&tag=#{URI.escape tag.to_s}"
+          end
+        else
+          args += "&#{URI.escape key.to_s}=#{URI.escape val.to_s}"
+        end
+        args[0] = '?'
+      end
+      path += args
+      response = RestClient.get path, @headers
+      begin
+        JSON.load response.to_str
+      rescue JSON::ParserError
+        # this should mean that fluidinfo returned a non-hash/array primitive
+        eval response.to_str
+      end
+    end
+
+    def head(path)
+      path = @instance + path
+      RestClient.head path
+    end
+    
+    def post(path, options={})
+      path = @instance + path
+      if options[:body]
+        if options[:mime]
+          mime = options[:mime]
+          body = options[:body]
+        else
+          mime = "application/json"
+          begin
+            body = JSON.dump options[:body]
+          rescue JSON::GeneratorError
+            body = options[:body]
+          end
+        end
+        headers = @headers.merge :content_type => mime
+        JSON.parse(RestClient.post path, body, headers)
+      else
+        JSON.parse(RestClient.post path, nil)
+      end
+    end
+    
+    def put(path, options={})
+      path = @instance + path
+      if options[:query]
+        query = URI.escape options[:query]
+        path += "?query=#{query}"
+      end
+      body = options[:body]
+      if options[:mime]
+        mime = options[:mime]
+      else
+        mime = "application/json"
+        begin
+          body = JSON.dump options[:body]
+        rescue JSON::GeneratorError
+          body = options[:body]
+        end
+      end
+      # nothing returned in response body for PUT
+      headers = @headers.merge :content_type => mime
+      RestClient.put path, body, headers
+    end
+    
+    def delete(path, options={})
+      path = @instance + path
+      if options[:query]
+        query = URI.escape options[:query]
+        path += "?query=#{query}"
+      end
+      if options[:tags]
+        options[:tags].each do |tag|
+          tag = URI.escape tag
+          path += "&tag=#{tag}"
+        end
+      end
+      # nothing returned in response body for DELETE
+      RestClient.delete path
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluidinfo'
+
+class Test::Unit::TestCase
+end

data/test/test_fluidinfo.rb

@@ -0,0 +1,76 @@
+require 'helper'
+
+class FluidinfoTest < Test::Unit::TestCase
+  context "GET" do
+    setup do
+      @fluid = Fluidinfo::Client.new
+    end
+
+    context "/objects" do
+      should "retrieve tags correctly" do
+        uid = "e034d8c0-a2e4-4094-895b-3a8065f9696e"
+        tag = "gridaphobe/given-name"
+        assert_equal "Eric", @fluid.get("/objects/#{uid}/#{tag}")
+      end
+
+      should "process queries correctly" do
+        query = 'fluiddb/users/username = "gridaphobe"'
+        expected = {
+          "ids" => ["e034d8c0-a2e4-4094-895b-3a8065f9696e"]
+        }
+        assert_equal expected, @fluid.get("/objects", :query => query)
+      end
+
+      should "retrieve objects with about tag" do
+        uid = "206b5ca5-cd69-469a-9aba-44b28cfb455e"
+        expected = {
+          "about"=>nil,
+          "tagPaths"=>["gridaphobe/test/test_tag"]
+        }
+        assert_equal expected, @fluid.get("/objects/#{uid}", :showAbout => true)
+      end
+      
+      should "retrieve objects without about tag" do
+        uid = "206b5ca5-cd69-469a-9aba-44b28cfb455e"
+        expected = {
+          "tagPaths"=>["gridaphobe/test/test_tag"]
+        }
+        assert_equal expected, @fluid.get("/objects/#{uid}")
+      end
+      
+      should "raise 404 errors on bad request" do
+        uid = "1"
+        tag = "gridaphobe/given-name"
+        assert_raise RestClient::ResourceNotFound do
+          @fluid.get "/objects/#{uid}/#{tag}"
+        end
+      end
+    end
+
+    context "/namespaces" do
+      should "show basic information about namespaces" do
+        user = "gridaphobe"
+        ns   = "test"
+        expected = {
+          "id"             =>"9c16dcbe-87fd-4fe9-ae0e-699be84f1105"
+        }
+        assert_equal expected, @fluid.get("/namespaces/#{user}/#{ns}")
+      end
+
+      should "show detailed information about namespaces" do
+        user = "gridaphobe"
+        ns   = "test"
+        expected = {
+          "tagNames"       => ["test_tag"],
+          "namespaceNames" => ["sub_ns"],
+          "id"             =>"9c16dcbe-87fd-4fe9-ae0e-699be84f1105",
+          "description"    =>"test"
+        }
+        assert_equal expected, @fluid.get("/namespaces/#{user}/#{ns}",
+                                          :returnDescription => true,
+                                          :returnTags => true,
+                                          :returnNamespaces => true)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification 
+name: fluidinfo
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Eric Seidel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-22 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rest-client
+  version_requirements: *id001
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: json
+  version_requirements: *id002
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  version_requirements: *id003
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id004
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id005
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id006
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rest-client
+  version_requirements: *id007
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: json
+  version_requirements: *id008
+  prerelease: false
+  type: :runtime
+description: This gem provides a simple interface to fluidinfo, built on top of the rest-client gem.
+email: gridaphobe@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- fluidinfo.gemspec
+- lib/fluidinfo.rb
+- test/helper.rb
+- test/test_fluidinfo.rb
+has_rdoc: true
+homepage: http://github.com/gridaphobe/fluidinfo
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Provides a simple interface to fluidinfo
+test_files: 
+- test/helper.rb
+- test/test_fluidinfo.rb