storage_room 0.1.0

data/lib/storage_room.rb

@@ -0,0 +1,89 @@
+$:.unshift(File.dirname(__FILE__)) unless
+	$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+begin; require 'rubygems'; rescue LoadError; end
+
+require 'httparty'
+require 'activesupport' 
+
+
+module StorageRoom
+  class AbstractMethod < RuntimeError; end
+  class RequestFailed < RuntimeError; end
+  
+  autoload :Attributes,     'storage_room/attributes'
+  
+  autoload :Base,           'storage_room/base'
+  autoload :Model,          'storage_room/model'
+  autoload :Array,          'storage_room/array'
+  autoload :Field,          'storage_room/field'
+  autoload :Embedded,          'storage_room/embedded'
+  
+  autoload :Collection,     'storage_room/models/collection'
+  autoload :Resource,       'storage_room/models/resource'
+  
+  autoload :File,           'storage_room/embeddeds/file'
+  autoload :Location,       'storage_room/embeddeds/location'
+
+
+  class << self
+    attr_reader :api_key
+    attr_reader :user_agent
+    attr_reader :account_id
+    attr_reader :ssl
+    attr_reader :proxy_server
+    attr_reader :proxy_port
+  
+    def authenticate(account_id, api_key)
+      Base.basic_auth(api_key, 'X')
+      @api_key = api_key
+      @account_id = account_id
+      update_uri
+    end
+    
+    def user_agent=(agent)
+      Base.headers.merge!('User-Agent' => agent)
+      @user_agent = agent
+    end
+
+    def server=(server)
+      @server = server
+      update_uri
+    end
+    
+    def server
+      @server || 'api.storageroomapp.com'
+    end
+        
+    def ssl=(ssl)
+      @ssl = ssl
+      update_uri
+    end
+    
+    def http_proxy(server, port)
+      @proxy_server = server
+      @proxy_port = port
+      Base.http_proxy(server, port)
+    end
+    
+    def update_uri
+      protocol = self.ssl == true ? 'https' : 'http'
+      
+      Base.base_uri "#{protocol}://#{self.server}/accounts/#{self.account_id}"
+    end
+    
+    def class_for_name(name)        
+      if StorageRoom.const_defined?(name)  
+        "StorageRoom::#{name}".constantize
+      elsif Object.const_defined?(name)
+        name.constantize
+      else
+        klass = Class.new(Resource) 
+        Object.const_set(name, klass)
+        
+        klass
+      end
+    end
+    
+  end
+end

data/spec/fixtures/collection.json

@@ -0,0 +1,38 @@
+{
+    "collection": {
+        "name": "Guidebooks",
+        "@updated_at": "2010-11-05T12:55:04Z",
+        "@resources_url": "http://api.storageroomapp.com/accounts/4c8fd48542507175aa00002f/collections/guidebooks/resources",
+        "@created_at": "2010-09-14T20:01:13Z",
+        "fields": [{
+            "name": "Title",
+            "required": true,
+            "default_value": "",
+            "allow_blank_choice": false,
+            "input_type": "text_field",
+            "@type": "StringField",
+            "hint": "",
+            "choices": [],
+            "identifier": "title"
+        },
+        {
+            "name": "PDF",
+            "required": false,
+            "input_type": "file",
+            "@type": "FileField",
+            "hint": "Upload a PDF file",
+            "identifier": "pdf"
+        },
+        {
+            "name": "location",
+            "required": false,
+            "input_type": "location",
+            "@type": "LocationField",
+            "hint": "",
+            "identifier": "location"
+        }],
+        "@type": "Collection",
+        "@url": "http://api.storageroomapp.com/accounts/4c8fd48542507175aa00002f/collections/guidebooks",
+        "identifier": "guidebooks"
+    }
+}

data/spec/fixtures/collections.json

@@ -0,0 +1,42 @@
+{
+    "collections": {
+        "@type": "Array",
+        "@url": "http://api.storageroomapp.com/accounts/4c8fd48542507175aa00002f/collections",
+        "items": [{
+            "name": "Guidebooks",
+            "@updated_at": "2010-11-05T12:55:04Z",
+            "@resources_url": "http://api.storageroomapp.com/accounts/4c8fd48542507175aa00002f/collections/guidebooks/resources",
+            "@created_at": "2010-09-14T20:01:13Z",
+            "fields": [{
+                "name": "Title",
+                "required": true,
+                "default_value": "",
+                "allow_blank_choice": false,
+                "input_type": "text_field",
+                "@type": "StringField",
+                "hint": "",
+                "choices": [],
+                "identifier": "title"
+            },
+            {
+                "name": "PDF",
+                "required": false,
+                "input_type": "file",
+                "@type": "FileField",
+                "hint": "Upload a PDF file",
+                "identifier": "pdf"
+            },
+            {
+                "name": "location",
+                "required": false,
+                "input_type": "location",
+                "@type": "LocationField",
+                "hint": "",
+                "identifier": "location"
+            }],
+            "@type": "Collection",
+            "@url": "http://api.storageroomapp.com/accounts/4c8fd48542507175aa00002f/collections/guidebooks",
+            "identifier": "guidebooks"
+        }]
+    }
+}

data/spec/fixtures/validation_error.json

@@ -0,0 +1,7 @@
+{
+    "error": {
+        "message": ["Title can't be empty"],
+        "code": 422,
+        "@type": "Error"
+    }
+}

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'storage_room'
+require 'spec'
+require 'spec/autorun'
+require 'webmock/rspec'
+
+Spec::Runner.configure do |config|
+  config.include WebMock::API
+  
+  config.before(:each) do
+    StorageRoom.authenticate('USER_ID', 'APPLICATION_API_KEY')
+  end
+end
+
+
+def stub_url(url)
+  "APPLICATION_API_KEY:X@api.storageroomapp.com/accounts/USER_ID#{url}"
+end
+
+def fixture_file(name)
+  path = File.expand_path("#{File.dirname(__FILE__)}/fixtures/#{name}")
+  File.read(path)
+end
+
+def mock_httparty(code)
+  httparty = mock('httparty')
+  response = mock('response')
+  response.stub(:code).and_return(code.to_s)
+  
+  httparty.stub(:response).and_return(response)
+  
+  httparty
+end

data/spec/storage_room/array_spec.rb

@@ -0,0 +1,77 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe StorageRoom::Array do
+  context "Class" do
+    context "Configuration" do
+  
+    end
+    
+    context "Methods" do
+      
+    end
+  end
+  
+  context "Instance" do
+    before(:each) do
+      @array = StorageRoom::Array.new
+    end
+    
+    describe "#initialize" do
+      it "should set items" do
+        @array.items.should == []
+      end
+    end
+    
+    describe "#set_from_api" do
+      before(:each) do
+        @hash = {'@page' => 1, 'items' => [{'one' => 1, '@type' => 'Guidebook'}, {'two' => 2, '@type' => 'Guidebook'}]}
+        @array.set_from_api(@hash)
+      end
+      
+      it "should set meta data" do
+        @array['@page'].should == 1
+      end
+      
+      it "should set items" do
+        @array.items.should have(2).items
+        @array.items[0].should be_an_instance_of(Guidebook)
+        @array.items[0][:one].should == 1
+        @array.items[1].should be_an_instance_of(Guidebook)        
+        @array.items[1][:two].should == 2
+      end
+    end
+    
+    describe "#reset!" do
+      it "should reset" do
+        @array.reset!
+        @array.items.should == []
+      end
+    end
+    
+    describe "#load_next_page!" do
+      it "should not load when not present" do
+        @array.load_next_page!.should be_false
+      end
+      
+      it "should load when present" do
+        @array[:@next_page] = "url"
+        @array.stub(:reload)
+        @array.should_receive(:reload)
+        @array.load_next_page!.should be_true
+      end
+    end
+    
+    describe "#load_previous_page!" do
+      it "should not load when not present" do
+        @array.load_previous_page!.should be_false
+      end
+      
+      it "should load when present" do
+        @array[:@previous_page] = "url"
+        @array.stub(:reload)
+        @array.should_receive(:reload)
+        @array.load_previous_page!.should be_true
+      end
+    end
+  end
+end

data/spec/storage_room/attributes_spec.rb

@@ -0,0 +1,82 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module StorageRoom
+  class TestAttributes
+    include Attributes
+  end
+end
+
+describe StorageRoom::TestAttributes do
+  
+  context "Instance" do
+    before(:each) do
+      @test = StorageRoom::TestAttributes.new(:test => 1, :@attr => 2)
+    end
+    
+    describe "#initialize" do    
+      it "should set attributes" do
+        @test[:test].should == 1
+        @test[:@attr].should == 2
+      end
+    end
+    
+    describe "#set_from_api" do  
+      before(:each) do
+        @test.set_from_api(:test2 => 3)
+      end
+        
+      it "should reset attributes" do
+        @test[:test].should be_nil
+        @test[:@attr].should be_nil
+      end
+      
+      it "should set new attributes" do
+        @test[:test2].should == 3
+      end
+    end
+    
+    describe "#[]" do
+      it "should get attribute" do
+        @test[:test].should == 1
+        @test[:@attr].should == 2
+      end
+    end
+    
+    describe "#[]=" do
+      it "should set attribute" do
+        @test[:test3] = 5
+        @test[:test3].should == 5
+      end
+    end
+    
+    describe "#attributes" do
+      it "should return existing attributes" do
+        @test.attributes[:test].should == 1
+        @test.attributes['test'].should == 1
+        @test.attributes[:@attr].should == 2
+        @test.attributes['@attr'].should == 2
+      end
+    end
+    
+    describe "#attributes=" do
+      before(:each) do
+        @test.attributes = {:new => 8, :test => 0}
+      end
+      
+      it "should set attributes" do
+        @test.attributes[:new].should == 8
+        @test.attributes[:test].should == 0
+        @test.attributes[:@attr].should == 2
+      end
+    end
+    
+    describe "#reset!" do
+      it "should reset" do        
+        @test.reset!
+        @test.attributes.should == {}
+      end
+    end
+
+  end
+  
+end

data/spec/storage_room/base_spec.rb

@@ -0,0 +1,110 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe StorageRoom::Base do
+  context "Class" do
+    context "Configuration" do
+      describe "Headers" do
+        it "should have User-Agent" do
+          StorageRoom::Base.headers['User-Agent'].should be_present
+        end
+      
+        it "should set Content Type" do
+          StorageRoom::Base.headers['Content-Type'].should == 'application/json'
+        end
+      
+        it "should set Accept" do
+          StorageRoom::Base.headers['Accept'].should == 'application/json'
+        end
+      end
+      
+      it "should not have base_uri" do
+        StorageRoom::Base.base_uri.should be_present
+      end
+      
+      it "should have format" do
+        StorageRoom::Base.default_options[:format].should == :json
+      end
+    end
+    
+    context "Methods" do      
+      describe "#load" do
+        it "should load" do
+          stub_request(:get, stub_url('/collections')).to_return(:body => fixture_file('collections.json'), :status => 200)
+          
+          array = StorageRoom::Array.load('/collections')          
+          array[:@type].should == 'Array'
+        end
+        
+        it "should raise on error" do
+          stub_request(:get, stub_url('/collections')).to_return(:status => 500)
+          
+          lambda {
+            StorageRoom::Array.load('/collections')
+          }.should raise_error(StorageRoom::RequestFailed)
+          
+        end
+      end
+            
+      describe "#handle_critical_response_errors" do
+        it "should handle no error" do
+          httparty = mock_httparty(200)
+          StorageRoom::Base.handle_critical_response_errors(httparty).should be_true
+        end
+        
+        it "should raise error" do
+          lambda {
+            StorageRoom::Base.handle_critical_response_errors(mock_httparty(500))
+          }.should raise_error(StorageRoom::RequestFailed)
+        end
+      end
+      
+      describe "#create_from_api" do
+        it "should create array" do
+          hash = {'@type' => 'Array', 'items' => []}
+          result = StorageRoom::Base.create_from_api(hash)
+          result.should be_an_instance_of(StorageRoom::Array)
+          result[:@type].should == 'Array'
+        end
+        
+        it "should create collection" do
+          hash = {'@type' => 'Collection', 'name' => 'Guidebook'}
+          result = StorageRoom::Base.create_from_api(hash)
+          result.should be_an_instance_of(StorageRoom::Collection)
+          result[:name].should == 'Guidebook'
+        end
+        
+        it "should create resource" do
+          hash = {'@type' => 'Guidebook', 'title' => 'Something'}
+          result = StorageRoom::Base.create_from_api(hash)
+          result.should be_an_instance_of(Guidebook)
+          result[:title].should == 'Something'
+        end
+      end
+      
+      describe "#meta_data?" do
+        it "should detect" do
+          StorageRoom::Base.meta_data?('@test').should be_true
+          StorageRoom::Base.meta_data?('test').should be_false
+        end
+      end
+      
+    end
+  end
+  
+  context "Instance" do
+    before(:each) do
+      @base = StorageRoom::Base.new(:test => 1, :@attr => 2)
+    end
+           
+    describe "#url" do
+      it "should return url" do
+        @base.url.should be_nil
+        @base[:@url] = 'url'
+        @base.url.should == 'url'
+      end
+    end
+    
+
+  end
+  
+end

data/spec/storage_room/embedded_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe StorageRoom::Embedded do
+
+end

data/spec/storage_room/embeddeds/file_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe StorageRoom::File do
+
+end

data/spec/storage_room/embeddeds/location_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe StorageRoom::Location do
+
+end

data/spec/storage_room/field_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe StorageRoom::Field do
+
+end