fluidinfo 0.2.1 → 0.2.2

data/Gemfile

@@ -2,8 +2,9 @@ source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
 #   gem "activesupport", ">= 2.3.5"
-gem "rest-client"
-gem "json"
+gem "rest-client", ">= 1.6.1"
+gem "json", ">= 1.5.1"
+gem "crack"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
@@ -12,4 +13,5 @@ group :development do
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"
+  gem "uuidtools", ">= 2.1.2"
 end

data/Gemfile.lock

@@ -1,6 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    crack (0.1.8)
     git (1.2.5)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
@@ -13,14 +14,17 @@ GEM
     rest-client (1.6.1)
       mime-types (>= 1.16)
     shoulda (2.11.3)
+    uuidtools (2.1.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0.0)
+  crack
   jeweler (~> 1.5.2)
-  json
+  json (>= 1.5.1)
   rcov
-  rest-client
+  rest-client (>= 1.6.1)
   shoulda
+  uuidtools (>= 2.1.2)

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/fluidinfo.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{fluidinfo}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eric Seidel"]
@@ -43,27 +43,33 @@ Gem::Specification.new do |s|
     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_runtime_dependency(%q<rest-client>, [">= 1.6.1"])
+      s.add_runtime_dependency(%q<json>, [">= 1.5.1"])
+      s.add_runtime_dependency(%q<crack>, [">= 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_development_dependency(%q<uuidtools>, [">= 2.1.2"])
     else
-      s.add_dependency(%q<rest-client>, [">= 0"])
-      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 1.6.1"])
+      s.add_dependency(%q<json>, [">= 1.5.1"])
+      s.add_dependency(%q<crack>, [">= 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<uuidtools>, [">= 2.1.2"])
     end
   else
-    s.add_dependency(%q<rest-client>, [">= 0"])
-    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 1.6.1"])
+    s.add_dependency(%q<json>, [">= 1.5.1"])
+    s.add_dependency(%q<crack>, [">= 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<uuidtools>, [">= 2.1.2"])
   end
 end
 

data/lib/fluidinfo.rb

@@ -2,6 +2,7 @@ require "rest-client"
 require "uri"
 require "json"
 require "base64"
+require "crack/json"
 
 module Fluidinfo
   class Client
@@ -10,27 +11,32 @@ module Fluidinfo
     # The sandbox instance, test your code here.
     @@SANDBOX = 'https://sandbox.fluidinfo.com'
     
-    def initialize(options={})
-      if options[:sandbox]
+    def initialize(instance=:main)
+      if instance == :sandbox
         @instance = @@SANDBOX
       else
         @instance = @@MAIN
       end
       @headers = {
-        "Accept" => "*/*"
+        :accept => "*/*"
       }
     end
 
     def login(user, pass)
       auth = "Basic " + (Base64.encode64 "#{user}:#{pass}").strip
-      @headers["Authorization"] = auth
+      @headers[:authorization] = auth
     end
 
     def logout
-      @headers.delete "Authorization"
+      @headers.delete :authorization
     end
 
-    # Call GET
+    ##
+    # Call GET on one of the APIs
+    #
+    # +options+ contains URI arguments that will be appended to +path+
+    # consult the {Fluidinfo API documentation}[api.fluidinfo.com] for a list of
+    # appropriate options
     def get(path, options={})
       path = @instance + path
       args = ''
@@ -50,36 +56,42 @@ module Fluidinfo
         JSON.load response.to_str
       rescue JSON::ParserError
         # this should mean that fluidinfo returned a non-hash/array primitive
-        eval response.to_str
+        Crack::JSON.parse response.to_str
       end
     end
 
+    ##
+    # Call HEAD on the /about or /object API to test for the existence
+    # of a tag
     def head(path)
       path = @instance + path
       RestClient.head path
     end
-    
+
+    ##
+    # Call POST on one of the APIs
+    #
+    # +options[:body]+ contains the request payload. For some API
+    # calls this may be empty.
     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
+        body = options[:body]
+        mime = "application/json"
+        body = JSON.dump options[:body]
         headers = @headers.merge :content_type => mime
         JSON.parse(RestClient.post path, body, headers)
       else
         JSON.parse(RestClient.post path, nil)
       end
     end
-    
+
+    ##
+    # Call PUT on one of the APIs
+    #
+    # +options[:body]+ contains the request payload.
+    #
+    # +options[:mime]+ contains the MIME-type unless the payload is JSON-encodable
     def put(path, options={})
       path = @instance + path
       if options[:query]
@@ -94,14 +106,24 @@ module Fluidinfo
         begin
           body = JSON.dump options[:body]
         rescue JSON::GeneratorError
-          body = options[:body]
+          if options[:body] == nil
+            body = "null"
+          else
+            body = options[:body].to_s
+          end
         end
       end
       # nothing returned in response body for PUT
       headers = @headers.merge :content_type => mime
       RestClient.put path, body, headers
     end
-    
+
+    ##
+    # Call DELETE on one of the APIs
+    #
+    # +options+ contains URI arguments that will be appended to +path+
+    # consult the {Fluidinfo API documentation}[api.fluidinfo.com] for a list of
+    # appropriate options
     def delete(path, options={})
       path = @instance + path
       if options[:query]
@@ -115,7 +137,7 @@ module Fluidinfo
         end
       end
       # nothing returned in response body for DELETE
-      RestClient.delete path
+      RestClient.delete path, @headers
     end
   end
 end

data/test/test_fluidinfo.rb

@@ -1,4 +1,5 @@
 require 'helper'
+require 'uuidtools'
 
 class FluidinfoTest < Test::Unit::TestCase
   context "GET" do
@@ -73,4 +74,68 @@ class FluidinfoTest < Test::Unit::TestCase
       end
     end
   end
+
+  context "POST" do
+    setup do
+      @fluid = Fluidinfo::Client.new :sandbox
+      @fluid.login 'test', 'test'
+    end
+
+    context "/namespaces" do
+      should "create new namespaces" do
+        new_ns = UUIDTools::UUID.random_create
+        body = {
+          'description' => 'a test namespace',
+          'name'        => new_ns
+        }
+        resp = @fluid.post "/namespaces/test", :body => body
+        # assert_equal 201, resp.code
+        assert_not_nil resp["id"]
+        
+        # now cleanup
+        @fluid.delete "/namespaces/test/#{new_ns}"
+      end
+    end
+  end
+
+  context "PUT" do
+    setup do
+      @fluid = Fluidinfo::Client.new :sandbox
+      @fluid.login 'test', 'test'
+    end
+
+    context "/tags" do
+      should "update tag values" do
+        new_ns = UUIDTools::UUID.random_create
+        ns_body = {
+          'description' => 'a test namespace',
+          'name' => new_ns
+        }
+        resp = @fluid.post '/namespaces/test', :body => ns_body
+        assert_not_nil resp["id"]
+        ns_id = resp["id"]      # for later use
+
+        new_tag = UUIDTools::UUID.random_create
+        tag_body = {
+          'description' => 'a test tag',
+          'name' => new_tag,
+          'indexed' => false
+        }
+        resp = @fluid.post "/tags/test/#{new_ns}", :body => tag_body
+        assert_not_nil resp["id"]
+        path = "/objects/#{ns_id}/test/#{new_ns}/#{new_tag}"
+        # Make sure that all primitive values are properly encoded and
+        # sent to Fluidinfo
+        primitives = [1, 1.1, "foo", true, nil, [1, 2, 3]]
+        primitives.each do |p|
+          resp = @fluid.put path, :body => p
+          assert_equal p, @fluid.get(path)
+        end
+
+        # now cleanup
+        @fluid.delete "/tags/test/#{new_ns}/#{new_tag}"
+        @fluid.delete "/namespaces/test/#{new_ns}"
+      end
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fluidinfo
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Eric Seidel
@@ -24,10 +24,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 13
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
   name: rest-client
   version_requirements: *id001
   prerelease: false
@@ -38,10 +40,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 1
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
   name: json
   version_requirements: *id002
   prerelease: false
@@ -56,12 +60,26 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: shoulda
+  name: crack
   version_requirements: *id003
   prerelease: false
-  type: :development
+  type: :runtime
 - !ruby/object:Gem::Dependency 
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  version_requirements: *id004
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -73,11 +91,11 @@ dependencies:
         - 0
         version: 1.0.0
   name: bundler
-  version_requirements: *id004
+  version_requirements: *id005
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -89,11 +107,11 @@ dependencies:
         - 2
         version: 1.5.2
   name: jeweler
-  version_requirements: *id005
+  version_requirements: *id006
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -103,7 +121,23 @@ dependencies:
         - 0
         version: "0"
   name: rcov
-  version_requirements: *id006
+  version_requirements: *id007
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  name: uuidtools
+  version_requirements: *id008
   prerelease: false
   type: :development
 description: This gem provides a simple interface to fluidinfo, built on top of the rest-client gem.