groupdocs 0.3.8 → 0.3.9

data/lib/groupdocs/document.rb

@@ -43,7 +43,7 @@ module GroupDocs
     # @option access [String] :private_key
     # @return [Array<GroupDocs::Document::View>]
     #
-    def self.views!(options = { page_index: 0 }, access = {})
+    def self.views!(options = {}, access = {})
       api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
@@ -345,13 +345,10 @@ module GroupDocs
     # @return [GroupDocs::Job]
     #
     # @raise [ArgumentError] if datasource is not GroupDocs::DataSource object
-    # @raise [ArgumentError] if options does not contain :new_type and/or :email_results
     #
-    def datasource!(datasource, options, access = {})
+    def datasource!(datasource, options = {}, access = {})
       datasource.is_a?(GroupDocs::DataSource) or raise ArgumentError,
         "Datasource should be GroupDocs::DataSource object, received: #{datasource.inspect}"
-      (options[:new_type].nil? || options[:email_results].nil?) and raise ArgumentError,
-        "Both :new_type and :email_results should be passed, received: #{options.inspect}"
 
       api = Api::Request.new do |request|
         request[:access] = access

data/lib/groupdocs/document/annotation.rb

@@ -5,7 +5,7 @@ module GroupDocs
 
     include Api::Helpers::AccessMode
 
-    TYPES  = %w(Text Area Point)
+    TYPES  = %w(Text Area Point TextStrikeout Polyline)
 
     # @attr [GroupDocs::Document] document
     attr_accessor :document
@@ -67,7 +67,7 @@ module GroupDocs
     #
     def type=(type)
       if type.is_a?(Symbol)
-        type = type.to_s.capitalize
+        type = accessor_to_variable(type).to_s.delete(?@)
         TYPES.include?(type) or raise ArgumentError, "Unknown type: #{type.inspect}"
       end
 
@@ -80,7 +80,7 @@ module GroupDocs
     # @return [Symbol]
     #
     def type
-      @type.downcase.to_sym
+      variable_to_accessor(@type)
     end
 
     #

data/lib/groupdocs/storage/file.rb

@@ -15,7 +15,7 @@ module GroupDocs
       #
       # @param [String] filepath Path to file to be uploaded
       # @param [String] upload_path Full path to directory to upload file to starting with "/".
-      #                      You can also add filename and then uploaded file will use it.
+      #                             You can also add filename and then uploaded file will use it.
       # @param [Hash] access Access credentials
       # @option access [String] :client_id
       # @option access [String] :private_key
@@ -62,7 +62,7 @@ module GroupDocs
 
       # @attr [Integer] id
       attr_accessor :id
-      # @attr [Integer] guid
+      # @attr [String] guid
       attr_accessor :guid
       # @attr [Integer] size
       attr_accessor :size
@@ -80,11 +80,11 @@ module GroupDocs
       attr_accessor :name
       # @attr [Integer] version
       attr_accessor :version
-      # @attr [Integer] type
+      # @attr [Symbol] type
       attr_accessor :type
-      # @attr [Integer] file_type
+      # @attr [Symbol] file_type
       attr_accessor :file_type
-      # @attr [Integer] access
+      # @attr [Symbol] access
       attr_accessor :access
       # @attr [String] path
       attr_accessor :path
@@ -116,6 +116,15 @@ module GroupDocs
         @type.downcase.to_sym
       end
 
+      #
+      # Returns file type in human-readable format.
+      #
+      # @return [Symbol]
+      #
+      def file_type
+        @file_type.downcase.to_sym
+      end
+
       #
       # Converts timestamp which is return by API server to Time object.
       #
@@ -143,6 +152,26 @@ module GroupDocs
         Time.at(@modified_on / 1000)
       end
 
+      #
+      # Uploads file to server.
+      #
+      # Note that it doesn't update self and instead returns new instance.
+      #
+      # @example
+      #   file = GroupDocs::Storage::File.new(name: 'document_one.doc', path: File.dirname(__FILE__))
+      #   file = file.upload!
+      #
+      # @param [String] upload_path Full path to directory to upload file to starting with "/".
+      #                             You can also add filename and then uploaded file will use it.
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [GroupDocs::Storage::File]
+      #
+      def upload!(upload_path = '/', access = {})
+        self.class.upload!("#{path}/#{name}", upload_path, access)
+      end
+
       #
       # Downloads file to given path.
       #

data/lib/groupdocs/storage/folder.rb

@@ -89,7 +89,7 @@ module GroupDocs
       attr_accessor :version
       # @attr [Integer] type
       attr_accessor :type
-      # @attr [Integer] access
+      # @attr [Symbol] access
       attr_accessor :access
 
       #
@@ -215,9 +215,16 @@ module GroupDocs
       #
       # Creates folder on server.
       #
+      # Note that it doesn't update self and instead returns new instance.
+      #
+      # @example
+      #   folder = GroupDocs::Storage::Folder.new(name: 'Folder')
+      #   folder = folder.create!
+      #
       # @param [Hash] access Access credentials
       # @option access [String] :client_id
       # @option access [String] :private_key
+      # @return [GroupDocs::Storage::Folder] Created folder
       #
       def create!(access = {})
         self.class.create!("/#{name}", access)

data/lib/groupdocs/version.rb

@@ -1,3 +1,3 @@
 module GroupDocs
-  VERSION = '0.3.8'
+  VERSION = '0.3.9'
 end # GroupDocs

data/spec/groupdocs/datasource_spec.rb

@@ -17,7 +17,7 @@ describe GroupDocs::DataSource do
 
     it 'accepts options hash' do
       lambda do
-        described_class.get!(1, fields: %w(field1 field2))
+        described_class.get!(1, field: %w(field1 field2))
       end.should_not raise_error(ArgumentError)
     end
 

data/spec/groupdocs/document/annotation_spec.rb

@@ -78,8 +78,8 @@ describe GroupDocs::Document::Annotation do
 
   describe '#type=' do
     it 'saves type in machine readable format if symbol is passed' do
-      subject.type = :area
-      subject.instance_variable_get(:@type).should == 'Area'
+      subject.type = :text_strikeout
+      subject.instance_variable_get(:@type).should == 'TextStrikeout'
     end
 
     it 'does nothing if parameter is not symbol' do
@@ -94,8 +94,8 @@ describe GroupDocs::Document::Annotation do
 
   describe '#type' do
     it 'returns type in human-readable format' do
-      subject.type = 'Area'
-      subject.type.should == :area
+      subject.type = 'TextStrikeout'
+      subject.type.should == :text_strikeout
     end
   end
 

data/spec/groupdocs/document_spec.rb

@@ -22,11 +22,6 @@ describe GroupDocs::Document do
       end.should_not raise_error(ArgumentError)
     end
 
-    it 'adds page index option by default' do
-      GroupDocs::Api::Request.any_instance.should_receive(:add_params).with({ page_index: 0 })
-      described_class.views!
-    end
-
     it 'returns an array of GroupDocs::Document::View objects' do
       views = described_class.views!
       views.should be_an(Array)
@@ -414,24 +409,22 @@ describe GroupDocs::Document do
 
     it 'accepts access credentials hash' do
       lambda do
-        subject.datasource!(datasource, { new_type: 1, email_results: false }, client_id: 'client_id', private_key: 'private_key')
+        subject.datasource!(datasource, {}, client_id: 'client_id', private_key: 'private_key')
       end.should_not raise_error(ArgumentError)
     end
 
-    it 'raises error if datasource is not GroupDocs::Datasource object' do
-      -> { subject.datasource!('Datasource') }.should raise_error(ArgumentError)
-    end
-
-    it 'raises error if :new_type option is not passed' do
-      -> { subject.datasource!(datasource, email_results: false) }.should raise_error(ArgumentError)
+    it 'accepts options hash' do
+      lambda do
+        subject.datasource!(datasource, new_type: :pdf)
+      end.should_not raise_error(ArgumentError)
     end
 
-    it 'raises error if :email_results option is not passed' do
-      -> { subject.datasource!(datasource, new_type: :doc) }.should raise_error(ArgumentError)
+    it 'raises error if datasource is not GroupDocs::Datasource object' do
+      -> { subject.datasource!('Datasource') }.should raise_error(ArgumentError)
     end
 
     it 'returns GroupDocs::Job object' do
-      job = subject.datasource!(datasource, new_type: :doc, email_results: false)
+      job = subject.datasource!(datasource)
       job.should be_a(GroupDocs::Job)
     end
   end
@@ -455,7 +448,7 @@ describe GroupDocs::Document do
       end
     end
 
-    it 'returns empty array if annotations are null in reponse' do
+    it 'returns empty array if annotations are null in response' do
       mock_api_server('{"status": "Ok", "result": {"annotations": null }}')
       subject.annotations!.should be_empty
     end

data/spec/groupdocs/storage/file_spec.rb

@@ -87,6 +87,13 @@ describe GroupDocs::Storage::File do
     end
   end
 
+  describe '#file_type' do
+    it 'returns file type in human-readable format' do
+      subject.file_type = 'Doc'
+      subject.file_type.should == :doc
+    end
+  end
+
   describe '#created_on' do
     it 'converts timestamp to Time object' do
       subject.created_on = 1330450135000
@@ -101,6 +108,31 @@ describe GroupDocs::Storage::File do
     end
   end
 
+  describe '#upload!' do
+    before(:each) do
+      mock_api_server(load_json('file_upload'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.upload!('/', client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'calls upload! class method and pass parameters to it' do
+      subject = described_class.new(name: File.basename(__FILE__), path: File.dirname(__FILE__))
+      described_class.should_receive(:upload!).with(__FILE__, '/Folder', {})
+      subject.upload!('/Folder')
+    end
+
+    it 'returns new GroupDocs::Storage::File object' do
+      subject = described_class.new(name: File.basename(__FILE__), path: File.dirname(__FILE__))
+      new_file = subject.upload!
+      new_file.should be_a(GroupDocs::Storage::File)
+      new_file.should_not == subject
+    end
+  end
+
   describe '#download!' do
     before(:each) do
       mock_api_server(File.read('spec/support/files/resume.pdf'))

data/spec/groupdocs/storage/folder_spec.rb

@@ -229,6 +229,13 @@ describe GroupDocs::Storage::Folder do
       described_class.should_receive(:create!).with('/Test1', {})
       subject.create!
     end
+
+    it 'returns new GroupDocs::Storage::Folder object' do
+      subject = described_class.new(name: 'Test1')
+      new_folder = subject.create!
+      new_folder.should be_a(GroupDocs::Storage::Folder)
+      new_folder.should_not == subject
+    end
   end
 
   describe '#delete!' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groupdocs
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-27 00:00:00.000000000 Z
+date: 2012-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &18874340 !ruby/object:Gem::Requirement
+  requirement: &4299240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.6'
   type: :runtime
   prerelease: false
-  version_requirements: *18874340
+  version_requirements: *4299240
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &18888780 !ruby/object:Gem::Requirement
+  requirement: &4314240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.7'
   type: :runtime
   prerelease: false
-  version_requirements: *18888780
+  version_requirements: *4314240
 - !ruby/object:Gem::Dependency
   name: ruby-hmac
-  requirement: &18887640 !ruby/object:Gem::Requirement
+  requirement: &4312700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *18887640
+  version_requirements: *4312700
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18886060 !ruby/object:Gem::Requirement
+  requirement: &4310660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '2.9'
   type: :development
   prerelease: false
-  version_requirements: *18886060
+  version_requirements: *4310660
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &18885040 !ruby/object:Gem::Requirement
+  requirement: &4309820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *18885040
+  version_requirements: *4309820
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &18884140 !ruby/object:Gem::Requirement
+  requirement: &4308540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '0.6'
   type: :development
   prerelease: false
-  version_requirements: *18884140
+  version_requirements: *4308540
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &18897000 !ruby/object:Gem::Requirement
+  requirement: &4320860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *18897000
+  version_requirements: *4320860
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &18894420 !ruby/object:Gem::Requirement
+  requirement: &4319120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: '1.8'
   type: :development
   prerelease: false
-  version_requirements: *18894420
+  version_requirements: *4319120
 description: Ruby SDK for GroupDocs REST API
 email: p0deje@gmail.com
 executables: []
@@ -256,7 +256,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2096644299297283301
+      hash: -1332657655199071037
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -265,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2096644299297283301
+      hash: -1332657655199071037
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10