dms 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    dms (0.0.1)
+      httparty (>= 0.6.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.2)
+    crack (0.1.8)
+    httparty (0.6.1)
+      crack (= 0.1.8)
+    rspec (1.3.1)
+    webmock (1.5.0)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.3)
+  dms!
+  httparty (>= 0.6.1)
+  rspec (= 1.3.1)
+  webmock (= 1.5.0)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/dms.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dms/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dms"
+  s.version     = DMS::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jose Fernandez"]
+  s.email       = ["jfernandez@fourcubed.com"]
+  s.homepage    = "http://rubygems.org/gems/dms"
+  s.summary     = %q{Ruby Gem for the FourCubed Data Management System}
+  s.description = %q{Ruby Gem for the FourCubed Data Management System.  Wrapper for the RESTful API}
+
+  s.rubyforge_project = "dms"
+  
+  s.add_dependency("httparty", ">= 0.6.1")
+  
+  s.add_development_dependency("bundler", ">= 1.0.3")
+  s.add_development_dependency("rspec", "1.3.1")
+  s.add_development_dependency("webmock", "1.5.0")
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/dms/api.rb

@@ -0,0 +1,58 @@
+module DMS
+  class API
+    include HTTParty
+    
+    base_uri "http://dms.fourcubed.com"
+    format :xml
+    
+    attr_accessor :api_token
+    attr_accessor :api_access_key
+    
+    def initialize(api_token = nil, api_access_key = nil)
+      @api_token      = api_token.to_s
+      @api_access_key = api_access_key.to_s
+    end
+    
+    def format_extension
+      ".#{self.class.format.to_s}"
+    end
+
+    def generate_timestamp
+      Time.now.to_i.to_s
+    end
+    
+    def slug_to_path(slug)
+      File.join("/", slug.to_s) + format_extension
+    end
+    
+    def get(slug)
+      response = perform_request(slug)
+      if response.code == 200
+        DMS::Node.new(response)
+      elsif response.code == 401
+        raise AuthenticationError.new(response.body)
+      elsif response.code == 404
+        raise ResourceNotFound.new(response.body)
+      else
+        raise UnknownError.new(response.body)
+      end
+    end
+    
+    private
+    
+      def generate_signature(request_method, path, timestamp) 
+        data = @api_token + request_method.to_s.upcase + path + timestamp
+        signature = OpenSSL::HMAC.digest(OpenSSL::Digest::SHA1.new, @api_access_key, data)
+        Base64.encode64(signature).chomp 
+      end
+    
+      def perform_request(slug)
+        raise "slug can't be blank!" if slug.blank?
+      
+        path      = slug_to_path(slug)
+        timestamp = generate_timestamp
+        signature = generate_signature(:get, path, timestamp)
+        self.class.get(path, :query => { :timestamp => timestamp, :signature => signature, :api_token => @api_token })
+      end
+  end
+end

data/lib/dms/node.rb

@@ -0,0 +1,17 @@
+module DMS
+  class Node
+    attr_reader :name
+    attr_reader :type
+    attr_reader :text
+    attr_reader :html
+    
+    def initialize(response)
+      @response = response
+      @name = @response.parsed_response.values.first["name"]
+      @type = @response.parsed_response.values.first["type"]
+      @text = @response.parsed_response.values.first["body"]
+      @html = @response.parsed_response.values.first["body"]
+    end
+  end
+  
+end

data/lib/dms/version.rb

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

data/lib/dms.rb

@@ -0,0 +1,12 @@
+module DMS
+  require 'httparty'
+  require 'openssl'
+  require 'base64'
+  
+  autoload :API, 'dms/api'
+  autoload :Node, 'dms/node'
+  
+  class ResourceNotFound < RuntimeError; end
+  class AuthenticationError < RuntimeError; end
+  class UnknownError < RuntimeError; end
+end

data/spec/api_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+describe DMS::API do
+  let(:responses) { YAML::load(File.open(File.join(File.dirname(__FILE__), 'fixtures', 'responses.yml'))) }
+  
+  before(:each) do
+    stub_request(:get, /dms\.fourcubed\.com/).to_return(responses[200])
+    @api = DMS::API.new("123456token", "123456key")
+  end
+  
+  describe "#get" do
+    it "calls #perform_request once with the slug" do
+      slug = "documents/1-foobar"
+      response = mock(HTTParty::Response, :code => 200, :parsed_response => { :document => {} })
+      @api.should_receive(:perform_request).once.with(slug).and_return(response)
+      @api.get(slug) 
+    end
+    
+    context "when the response has a status code of 200" do
+      before(:each) do
+        stub_request(:get, /dms\.fourcubed\.com/).to_return(responses[200])
+      end
+      
+      it "returns an instance of DMS::Node" do
+        @api.get("documents/1-foobar").should be_an_instance_of(DMS::Node)
+      end
+    end
+    
+    context "when the response has a status code of 401" do
+      before(:each) do
+        stub_request(:get, /dms\.fourcubed\.com/).to_return(responses[401])
+      end
+      
+      it "raises DMS::AuthenticationError" do
+        lambda { @api.get("documents/1-foobar") }.should raise_error(DMS::AuthenticationError)
+      end
+    end
+    
+    context "when the response has a status code of 404" do
+      before(:each) do
+        stub_request(:get, /dms\.fourcubed\.com/).to_return(responses[404])
+      end
+      
+      it "raises DMS::ResourceNotFound" do
+        lambda { @api.get("documents/1-foobar") }.should raise_error(DMS::ResourceNotFound)
+      end
+    end
+    
+    context "when the response has status code of 500" do
+      before(:each) do
+        stub_request(:get, /dms\.fourcubed\.com/).to_return(responses[500])
+      end
+      
+      it "raises DMS::UnknownError" do
+        lambda { @api.get("documents/1-foobar") }.should raise_error(DMS::UnknownError)
+      end
+    end
+  end
+  
+  describe "#slug_to_path" do
+    it "appends #format_extension" do
+      @api.slug_to_path("documents/1-foobar").should match /#{@api.format_extension}$/
+    end
+    
+    it "prepends a '/'" do
+      @api.slug_to_path("documents/1-foobar").should match /^\/{1}/
+    end
+    
+    context "when slug is nil" do
+      it "does not raise an error" do
+        lambda { @api.slug_to_path(nil) }.should_not raise_error
+      end
+    end
+    
+    context "when slug is blank" do
+      it "does not raise an error" do
+        lambda { @api.slug_to_path('') }.should_not raise_error
+      end
+    end
+    
+    context "when slug includes a trailing '/'" do
+      it "does not prepend another '/'" do
+        @api.slug_to_path("/documents/1-foobar").should_not match /^\/{2}/
+      end
+    end
+  end
+  
+  describe "#generate_signature" do
+    before(:each) do
+      @api.api_token = "71e49b70c5f5012dda13002332b13ba0"
+      @api.api_access_key = "24xPxvzEgXPa5eWW7ZTirQqVt1g3NkVil5UYLUnx"
+      @timestamp = "12345567890"
+    end
+    
+    it "correctly generates the signature" do
+      @api.send(:generate_signature, :get, 'foo', @timestamp).should == "omfvZVlOncdqPsyLa1e5/0feDgc="
+    end
+  end
+  
+  describe "#perform_request" do
+    it "returns an instance of HTTParty::Response" do
+      @api.send(:perform_request, "documents/1-foo").class == HTTParty::Response
+    end
+    
+    it "calls DMS::API.get with the correct path generated from the slug as the first parameter" do
+      slug = "documents/1-foobar"
+      path = @api.slug_to_path(slug)
+      
+      DMS::API.should_receive(:get).once.with(path, anything())
+      @api.send(:perform_request, slug)
+    end
+    
+    it "calls .get with a query hash as a second parameter that includes the api_token" do
+      slug = "documents/1-foobar"
+      
+      DMS::API.should_receive(:get).once.with(anything(), {:query => hash_including(:api_token => @api.api_token)})
+      @api.send(:perform_request, slug)
+    end
+    
+    it "calls .get with a query hash as a second parameter that includes the timestamp" do
+      slug = "documents/1-foobar"
+      timestamp = "12345567890"
+      @api.stub(:generate_timestamp).and_return(timestamp)
+      
+      DMS::API.should_receive(:get).once.with(anything(), {:query => hash_including(:timestamp => timestamp)})
+      @api.send(:perform_request, slug)
+    end
+    
+    it "calls .get with a query hash as a second parameter that includes the signature" do
+      slug = "documents/1-foobar"
+      signature = "dfhdskf12109231203ssdfsflksdjfl23klddsk"
+      @api.stub(:generate_signature).and_return(signature)
+      
+      DMS::API.should_receive(:get).once.with(anything(), { :query => hash_including(:signature => signature) })
+      @api.send(:perform_request, slug)
+    end
+    
+    context "when slug is nil" do
+      it "raises an error" do
+        lambda { @api.send(:perform_request, nil) }.should raise_error("slug can't be blank!")
+      end
+    end
+    
+    context "when slug is blank" do
+      it "raises an error" do
+        lambda { @api.send(:perform_request, '') }.should raise_error("slug can't be blank!")
+      end
+    end
+  end
+end

data/spec/fixtures/responses.yml

@@ -0,0 +1,62 @@
+200: |
+  HTTP/1.1 200 OK
+  Content-Type: application/xml; charset=utf-8
+  Transfer-Encoding: chunked
+  Connection: keep-alive
+  Status: 200
+  X-Powered-By: Phusion Passenger (mod_rails/mod_rack) 2.2.10
+  ETag: "5c7e90c6c325b5546c28ea8f9ac510ab"
+  X-UA-Compatible: IE=Edge,chrome=1
+  X-Runtime: 0.009064
+  Cache-Control: max-age=0, private, must-revalidate
+  Server: nginx/0.6.35 + Phusion Passenger 2.2.10 (mod_rails/mod_rack)
+
+  <?xml version="1.0" encoding="UTF-8"?>
+  <document>
+    <name>Foobar</name>
+    <body nil="true">This is the body</body>
+    <id type="integer">1</id>
+    <type>Document</type>
+  </document>
+
+401: |
+  HTTP/1.1 401 Unauthorized
+  Content-Type: text/plain; charset=utf-8
+  Transfer-Encoding: chunked
+  Connection: keep-alive
+  Status: 401
+  X-Powered-By: Phusion Passenger (mod_rails/mod_rack) 2.2.10
+  X-UA-Compatible: IE=Edge,chrome=1
+  X-Runtime: 0.004468
+  Cache-Control: no-cache
+  Server: nginx/0.6.35 + Phusion Passenger 2.2.10 (mod_rails/mod_rack)
+
+  Invalid Signature
+  
+404: |
+  HTTP/1.1 404 Not Found
+  Content-Type: text/html; charset=utf-8
+  Transfer-Encoding: chunked
+  Connection: keep-alive
+  Status: 404
+  X-Powered-By: Phusion Passenger (mod_rails/mod_rack) 2.2.10
+  X-UA-Compatible: IE=Edge,chrome=1
+  X-Runtime: 0.008075
+  Cache-Control: no-cache
+  Server: nginx/0.6.35 + Phusion Passenger 2.2.10 (mod_rails/mod_rack)
+
+  Couldn't find Document with ID: 999-Foobar
+
+500: |
+  HTTP/1.1 500 Internal Server Error
+  Content-Type: text/html; charset=utf-8
+  Transfer-Encoding: chunked
+  Connection: keep-alive
+  Status: 500
+  X-Powered-By: Phusion Passenger (mod_rails/mod_rack) 2.2.10
+  X-UA-Compatible: IE=Edge,chrome=1
+  X-Runtime: 0.008075
+  Cache-Control: no-cache
+  Server: nginx/0.6.35 + Phusion Passenger 2.2.10 (mod_rails/mod_rack)
+
+  Server is not responding!

data/spec/node_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe DMS::Node do
+  let(:responses) { YAML::load(File.open(File.join(File.dirname(__FILE__), 'fixtures', 'responses.yml'))) }
+  
+  before(:each) do
+    stub_request(:get, /dms\.fourcubed\.com/).to_return(responses[200])
+    @api = DMS::API.new("123456token", "123456key")
+  end
+  
+  describe "#initialize" do
+    context "when a valid HTTParty::Response instance is passed" do
+      before(:each) do
+        @response = @api.send(:perform_request, "documents/1-foobar")
+      end
+      
+      it "sets the @name value correct" do
+        @node = DMS::Node.new(@response)
+        @node.name.should == "Foobar"
+      end
+      
+      it "sets the @type value correct" do
+        @node = DMS::Node.new(@response)
+        @node.type.should == "Document"
+      end
+      
+      it "sets the @text value correct" do
+        @node = DMS::Node.new(@response)
+        @node.text.should == "This is the body"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'bundler/setup'
+require 'dms'
+require 'spec'
+require 'webmock/rspec'
+
+Spec::Runner.configure do |config|
+  config.include WebMock::API
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification 
+name: dms
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jose Fernandez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 0
+        - 3
+        version: 1.0.3
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  type: :development
+  version_requirements: *id004
+description: Ruby Gem for the FourCubed Data Management System.  Wrapper for the RESTful API
+email: 
+- jfernandez@fourcubed.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- dms.gemspec
+- lib/dms.rb
+- lib/dms/api.rb
+- lib/dms/node.rb
+- lib/dms/version.rb
+- spec/api_spec.rb
+- spec/fixtures/responses.yml
+- spec/node_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/dms
+licenses: []
+
+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: dms
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby Gem for the FourCubed Data Management System
+test_files: 
+- spec/api_spec.rb
+- spec/fixtures/responses.yml
+- spec/node_spec.rb
+- spec/spec_helper.rb