ruby-box-updated 1.16.0

data/spec/client_spec.rb

@@ -0,0 +1,64 @@
+#encoding: UTF-8
+
+require 'spec_helper'
+require 'helper/account'
+require 'ruby-box'
+require 'webmock/rspec'
+
+describe RubyBox::Client do
+  before do
+    @session = RubyBox::Session.new
+  end
+
+  describe '#folder' do
+    it "should return root folder as default behavior for paths such as ./" do
+      RubyBox::Client.any_instance.should_receive(:root_folder).exactly(4).times
+      client = RubyBox::Client.new(@session)
+      client.folder()
+      client.folder('.')
+      client.folder('./')
+      client.folder('/')
+    end
+  end
+
+  describe '#split_path' do
+    it "returns the appropriate path" do
+      client = RubyBox::Client.new(@session)
+      client.split_path('foo/bar').should == ['foo', 'bar']
+    end
+
+    it "leading / is ignored" do
+      client = RubyBox::Client.new(@session)
+      client.split_path('/foo/bar').should == ['foo', 'bar']
+    end
+
+    it "trailing / is ignored" do
+      client = RubyBox::Client.new(@session)
+      client.split_path('foo/bar/').should == ['foo', 'bar']
+    end
+  end
+  
+  describe '#create_folder' do
+    it 'doesnt call folder.create_folder if the folder exists' do
+      client = RubyBox::Client.new(@session)
+      mock_root_folder = mock( Object )
+      test_folder = mock( Object )
+      mock_root_folder.should_receive(:folders).and_return([test_folder])
+      mock_root_folder.should_not_receive(:create_subfolder)
+      client.should_receive(:root_folder).and_return(mock_root_folder)
+      result = client.create_folder( '/test0')
+      result.should == test_folder
+    end
+    
+    it 'calls folder.create_folder if the folder does not exist' do
+      client = RubyBox::Client.new(@session)
+      mock_root_folder = mock( Object )
+      test_folder = mock( Object )
+      mock_root_folder.should_receive(:folders).and_return([])
+      mock_root_folder.should_receive(:create_subfolder).and_return(test_folder)
+      client.should_receive(:root_folder).and_return(mock_root_folder)
+      result = client.create_folder( '/test0')
+      result.should == test_folder
+    end
+  end
+end

data/spec/event_spec.rb

@@ -0,0 +1,70 @@
+#encoding: UTF-8
+
+require 'ruby-box'
+require 'webmock/rspec'
+
+describe RubyBox::EventResponse do
+  before do
+    @session = RubyBox::Session.new
+    @client  = RubyBox::Client.new(@session)
+    @events_json  = File.read 'spec/fixtures/events.json'
+    @events = JSON.load @events_json
+    stub_request(:get, /#{RubyBox::API_URL}\/events.*/).to_return(body: @events_json, :status => 200)
+  end
+
+  it 'returns an EventResponse with a chunk_size and next_stream_position' do
+    eresp = @client.event_response
+    eresp.instance_of?(RubyBox::EventResponse).should be_true
+    eresp.events.instance_of?(Array).should be_true
+    eresp.chunk_size.should eq(@events['chunk_size'])
+    eresp.events.length.should eq(@events['chunk_size'])
+    eresp.next_stream_position.should eq(@events['next_stream_position'])
+  end
+
+  it "should not try to reload_meta since has_mini_format? is false" do
+    # request is called once when reload_meta is automatically executed.
+    RubyBox::Session.any_instance.should_not_receive(:request)
+    response = @client.event_response
+    event = response.events.first
+    event.missing_key
+  end
+
+  it '#fmt_events_args should return a properly formatted URL' do
+    @client.send(:fmt_events_args, 0, :all, 100).should eql("stream_position=0&stream_type=all&limit=100")
+    @client.send(:fmt_events_args, 'now', :changes, 55).should eql("stream_position=now&stream_type=changes&limit=55")
+  end
+
+  describe '#event_response' do
+    before do
+      @response = @client.event_response
+      @event = @response.events.first
+    end
+
+    it 'should return Event objects in the event response' do
+      @event.instance_of?(RubyBox::Event).should be_true
+    end
+
+    it 'should return an #event_id' do
+      @event.event_id.should eq(@events['entries'][0]['event_id'])
+    end
+
+    it 'should return a User for #created_by' do
+      @event.created_by.instance_of?(RubyBox::User).should be_true
+    end
+
+    it 'should return an #event_type' do
+      @event.event_type.should eq(@events['entries'][0]['event_type'])
+    end
+
+    it 'should return a #session_id' do
+      @event.session_id.should eq(@events['entries'][0]['session_id'])
+    end
+
+    it 'should return an instantiated #source' do
+      @event.source.instance_of?(RubyBox::Folder).should be_true
+    end
+
+  end
+
+end
+

data/spec/file_spec.rb

@@ -0,0 +1,110 @@
+#encoding: UTF-8
+
+require 'spec_helper'
+require 'helper/account'
+require 'ruby-box'
+require 'webmock/rspec'
+
+describe RubyBox::File do
+
+  before do
+    @session = RubyBox::Session.new
+    @full_file = JSON.parse('{   "type": "file",    "id": "5000948880",    "sequence_id": "3",    "etag": "3",    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",    "name": "tigers.jpeg",    "description": "a picture of tigers",    "size": 629644,    "path_collection": {        "total_count": 2,        "entries": [            {                "type": "folder",                "id": "0",                "sequence_id": null,                "etag": null,                "name": "All Files"            },            {                "type": "folder",                "id": "11446498",                "sequence_id": "1",                "etag": "1",                "name": "Pictures"            }        ]    },    "created_at": "2012-12-12T10:55:30-08:00",    "modified_at": "2012-12-12T11:04:26-08:00",    "trashed_at": null,    "purged_at": null,    "content_created_at": "2013-02-04T16:57:52-08:00",    "content_modified_at": "2013-02-04T16:57:52-08:00",    "created_by": {        "type": "user",        "id": "17738362",        "name": "sean rose",        "login": "sean@box.com"    },    "modified_by": {        "type": "user",        "id": "17738362",        "name": "sean rose",        "login": "sean@box.com"    },    "owned_by": {        "type": "user",        "id": "17738362",        "name": "sean rose",        "login": "sean@box.com"    },    "shared_link": {        "url": "https://www.box.com/s/rh935iit6ewrmw0unyul",        "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",        "vanity_url": null,        "is_password_enabled": false,        "unshared_at": null,        "download_count": 0,        "preview_count": 0,        "access": "open",        "permissions": {            "can_download": true,            "can_preview": true        }    },    "parent": {        "type": "folder",        "id": "11446498",        "sequence_id": "1",        "etag": "1",        "name": "Pictures"    },    "item_status": "active"}')
+    @mini_file = JSON.parse('{    "sequence_id": "0",    "type": "file",    "id": "2631999573",    "name":"IMG_1312.JPG"}')
+    @comments = JSON.parse('{    "total_count": 1,    "entries": [        {            "type": "comment",            "id": "191969",            "is_reply_comment": false,            "message": "These tigers are cool!",            "created_by": {                "type": "user",                "id": "17738362",                "name": "sean rose",                "login": "sean@box.com"            },            "created_at": "2012-12-12T11:25:01-08:00",            "item": {                "id": "5000948880",                "type": "file"            },            "modified_at": "2012-12-12T11:25:01-08:00"        }    ]}')
+  end
+
+  it "should use missing_method to expose files fields" do
+    file = RubyBox::File.new(@session, @mini_file)
+    file.id.should == '2631999573'
+  end
+
+  it "should load all meta information if reload_meta is called" do
+    # request is called once when reload_meta is automatically executed.
+    RubyBox::Session.any_instance.should_receive(:request).once.and_return(@full_file)
+    session = RubyBox::Session.new
+
+    file = RubyBox::File.new(session, @mini_file)
+    file.size.should == 629644
+  end
+
+  describe '#parent' do
+    it 'should return parent folder' do
+      session = RubyBox::Session.new
+      file = RubyBox::File.new(session, @full_file)
+      file.parent.name.should == 'Pictures'
+    end
+
+    it 'should reload_meta data if necessary before loading parent' do
+      RubyBox::Session.any_instance.stub(:request).and_return(@full_file)
+      session = RubyBox::Session.new
+      file = RubyBox::File.new(session, @mini_file)
+      file.parent.name.should == 'Pictures'
+    end
+  end
+
+  describe '#update' do
+    it 'should update files raw_item hash if name or description changed' do
+      RubyBox::Session.any_instance.stub(:request).and_return(@full_file)
+      session = RubyBox::Session.new
+      file = RubyBox::File.new(session, @mini_file)
+      file.name = 'Funky Monkey.jpg'
+      file.description = 'a new description'
+      file.name.should == 'Funky Monkey.jpg'
+      file.description.should == 'a new description'    
+    end
+
+    it 'should not update files raw_item hash for keys not in update_fields' do
+      RubyBox::Session.any_instance.stub(:request).and_return(@full_file)
+      session = RubyBox::Session.new
+      file = RubyBox::File.new(session, @mini_file)
+      file.id = '000'
+      file.id.should == '2631999573'
+    end
+
+    it 'should make request with appropriate update hash when update called' do
+      RubyBox::Session.any_instance.stub(:request) do |uri, request|
+        data = JSON.parse(request.body)
+        data['description'].should == 'a new description'
+      end
+      session = RubyBox::Session.new
+      file = RubyBox::File.new(session, @full_file)
+      file.description = 'a new description'
+      file.update
+    end
+  end
+
+  describe '#put_data' do
+    it "should load full meta information if etag not present" do
+      RubyBox::Session.any_instance.should_receive(:request).twice.and_return(@full_file)
+      session = RubyBox::Session.new
+      file = RubyBox::File.new(session, @mini_file)
+      file.stub(:prepare_upload).and_return('fake data')
+      file.update_content('data')
+    end
+  end
+
+  describe '#comments' do
+    it 'should return an array of comment objects' do
+      RubyBox::Session.any_instance.stub(:request).and_return(@comments)
+      session = RubyBox::Session.new
+      file = RubyBox::File.new(session, @mini_file)
+      file.comments.first.message.should == 'These tigers are cool!'
+    end
+  end
+
+  describe '#create_comment' do
+    it 'calls the /comments resource with the appropriate post body' do
+      stub_request(:post, "https://api.box.com/2.0/comments")
+        .to_return(:body => File.read('./spec/fixtures/comment_create.json'), :status => 200)
+
+      session = RubyBox::Session.new
+      file = RubyBox::File.new(session, @mini_file)
+      comment = file.create_comment('Hello world!')
+
+      # note that this value comes from the fixture.
+      comment.message.should == 'These tigers are cool!'
+    end
+  end
+
+end

data/spec/fixtures/comment_create.json

@@ -0,0 +1,18 @@
+{
+    "type": "comment",
+    "id": "191969",
+    "is_reply_comment": false,
+    "message": "These tigers are cool!",
+    "created_by": {
+        "type": "user",
+        "id": "17738362",
+        "name": "sean rose",
+        "login": "sean@box.com"
+    },
+    "created_at": "2012-12-12T11:25:01-08:00",
+    "item": {
+        "id": "5000948880",
+        "type": "file"
+    },
+    "modified_at": "2012-12-12T11:25:01-08:00"
+}

data/spec/fixtures/events.json

@@ -0,0 +1,161 @@
+{
+  "chunk_size": 3,
+  "next_stream_position": 1366038336000,
+  "entries": [
+    {
+      "type": "event",
+      "event_id": "dd4cba8afb2acb3cc0ecc43c81e565e78886494b",
+      "created_by": {
+        "type": "user",
+        "id": "000000000",
+        "name": "Example User",
+        "login": "test@example.com"
+      },
+      "created_at": "2013-04-12T13:53:52-07:00",
+      "recorded_at": "2013-04-12T13:53:52-07:00",
+      "event_type": "ITEM_CREATE",
+      "session_id": "d223c5ba4f4eb1d0b4fb55a",
+      "source": {
+        "type": "folder",
+        "id": "805142927",
+        "sequence_id": "0",
+        "etag": "0",
+        "name": "Test Folder",
+        "created_at": "2013-04-12T13:53:52-07:00",
+        "modified_at": "2013-04-12T13:53:52-07:00",
+        "description": "",
+        "size": 0,
+        "path_collection": {
+          "total_count": 1,
+          "entries": [
+            {
+              "type": "folder",
+              "id": "0",
+              "sequence_id": null,
+              "etag": null,
+              "name": "All Files"
+            }
+          ]
+        },
+        "created_by": {
+          "type": "user",
+          "id": "000000000",
+          "name": "Example User",
+          "login": "test@example.com"
+        },
+        "modified_by": {
+          "type": "user",
+          "id": "000000000",
+          "name": "Example User",
+          "login": "test@example.com"
+        },
+        "trashed_at": null,
+        "purged_at": null,
+        "content_created_at": "2013-04-12T13:53:52-07:00",
+        "content_modified_at": "2013-04-12T13:53:52-07:00",
+        "owned_by": {
+          "type": "user",
+          "id": "000000000",
+          "name": "Example User",
+          "login": "test@example.com"
+        },
+        "shared_link": null,
+        "folder_upload_email": null,
+        "parent": {
+          "type": "folder",
+          "id": "0",
+          "sequence_id": null,
+          "etag": null,
+          "name": "All Files"
+        },
+        "item_status": "active",
+        "synced": false
+      }
+    },
+    {
+      "type": "event",
+      "event_id": "dd4cba8afb2acb3cc0ecc43c81e565e78886494c",
+      "created_by": {
+        "type": "user",
+        "id": "000000000",
+        "name": "Example User",
+        "login": "test@example.com"
+      },
+      "created_at": "2013-04-12T13:54:25-07:00",
+      "recorded_at": "2013-04-12T13:54:26-07:00",
+      "event_type": "ITEM_RENAME",
+      "session_id": "d223c5ba4f4eb1d0b4fb55a",
+      "source": {
+        "type": "folder",
+        "id": "805142927",
+        "sequence_id": "1",
+        "etag": "1",
+        "name": "Test Folder",
+        "created_at": "2013-04-12T13:53:52-07:00",
+        "modified_at": "2013-04-12T13:54:25-07:00",
+        "description": "Project: Test",
+        "size": 0,
+        "path_collection": {
+          "total_count": 1,
+          "entries": [
+            {
+              "type": "folder",
+              "id": "0",
+              "sequence_id": null,
+              "etag": null,
+              "name": "All Files"
+            }
+          ]
+        },
+        "created_by": {
+          "type": "user",
+          "id": "000000000",
+          "name": "Example User",
+          "login": "test@example.com"
+        },
+        "modified_by": {
+          "type": "user",
+          "id": "000000000",
+          "name": "Example User",
+          "login": "test@example.com"
+        },
+        "trashed_at": null,
+        "purged_at": null,
+        "content_created_at": "2013-04-12T13:53:52-07:00",
+        "content_modified_at": "2013-04-12T13:54:25-07:00",
+        "owned_by": {
+          "type": "user",
+          "id": "000000000",
+          "name": "Example User",
+          "login": "test@example.com"
+        },
+        "shared_link": null,
+        "folder_upload_email": null,
+        "parent": {
+          "type": "folder",
+          "id": "0",
+          "sequence_id": null,
+          "etag": null,
+          "name": "All Files"
+        },
+        "item_status": "active",
+        "synced": false
+      }
+    },
+    {
+      "type": "event",
+      "event_id": "dd4cba8afb2acb3cc0ecc43c81e565e78886494d",
+      "created_by": {
+        "type": "user",
+        "id": "000000000",
+        "name": "Example User",
+        "login": "test@example.com"
+      },
+      "created_at": "2013-04-12T14:02:06-07:00",
+      "recorded_at": "2013-04-12T14:02:06-07:00",
+      "event_type": "TAG_ITEM_CREATE",
+      "session_id": "d223c5ba4f4eb1d0b4fb55a",
+      "source": null
+    }
+  ]
+}

data/spec/fixtures/me.json

@@ -0,0 +1,17 @@
+{
+    "type": "user",
+    "id": "10000000",
+    "name": "Test User",
+    "login": "test@example.com",
+    "created_at": "2013-05-01T11:26:07-05:00",
+    "modified_at": "2013-05-01T11:26:07-05:00",
+    "language": "en",
+    "space_amount": 2400000000,
+    "space_used": 2000000,
+    "max_upload_size": 200000000,
+    "status": "active",
+    "job_title": "Unit Tester",
+    "phone": "5555555555",
+    "address": "600 Unit Test Way",
+    "avatar_url": "https://www.box.com/api/avatar/large/10000000"
+}