groupdocs 0.3.11 → 1.0.0

data/CHANGELOG.md

@@ -0,0 +1,150 @@
+## v1.0
+
+**New**
+
+* Added fully-featured Signature API
+* Added API to retrieve subscription plans
+* Added `Annotation#set_access!` to control annotation access: public or private
+* Added `Job.get!` to retrieve job by its identifier
+* Added `Job#delete_document!`
+* Added `File.upload_web!` to convert webpages to documents
+* Added `File#move_to_trash!`
+* Added `User.users!` to retrieve my account's users
+
+**Changes**
+
+* `File` and `Folder` has changed the way paths are handled. Path should no longer start with `/`
+* `File.upload!` now accept hash of options as argument: `:path` to upload to, `:name` to rename file, `:description` to add description to file
+* `File#move!` now accept hash of options as argument: `:name` to rename file
+* `File#copy!` now accept hash of options as argument: `:name` to rename file
+
+**Removed**
+
+* `Document.all!` is removed (slow recursive implementation)
+* `Document.find!` is removed (slow recursive implementation)
+* `Document.find_all!` is removed (slow recursive implementation)
+* `File.all!` is removed (slow recursive implementation)
+* `File.find!` is removed (slow recursive implementation)
+* `File.find_all!` is removed (slow recursive implementation)
+* `Folder.all!` is removed (slow recursive implementation)
+* `Folder.find!` is removed (slow recursive implementation)
+* `Folder.find_all!` is removed (slow recursive implementation)
+* `Extensions::LookUp` is removed (slow recursive implementation)
+* `File#upload!` is removed (not really needed, use `File.upload!`)
+* `Folder#rename!` is removed (has some quirks due to API, use `Folder#move!` instead)
+
+## v0.3.11
+
+* Fix for critical bug in `Entity#to_hash`
+
+## v0.3.10
+
+* Updated `Document#metadata!`
+* Fixed `Folder#move!`
+* Fixed `Folder#copy!`
+
+## v0.3.9
+
+* Added `File#upload!`
+* Proper handling of `File#file_type`
+* More annotation types
+* `Document#datasource!` options are now optional
+
+## v0.3.8
+
+* Updated `Datasource for new API
+* Updated `Datasource::Field` for new API
+* Some minor fixes
+
+## v0.3.7
+
+* More flexible `Execution#owner=` and specs for it
+* More flexible `Execution#executive=` and specs for it
+* More flexible `Execution#approver=` and specs for it
+
+## v0.3.6
+
+* `Questionnaire::Execution` now returns objects for`owner`, `executive` and `approver`
+
+## v0.3.5
+
+* Methods to retrieve and update user profile information
+
+## v0.3
+
+**This release breaks backwards compatibility**
+
+New API version uses strings for job actions, access modes, statuses, file types, etc. This release reflects corresponding changes.
+
+## v0.2.11
+
+* Added `Questionnaire#default_answer` and `Questionnaire#default_answer=`
+
+## v0.2.10
+
+* Added `Annotation#collaborators!`
+
+## v0.2.9
+
+* Added `Annotation#position`
+* Added `Annotation#move!`
+
+## v0.2.8
+
+* Human-readable `Annotation#access`
+* Machine-readable `Annotation#access=`
+* `Document#annotations!` now handles `null` in "annotations" response
+
+## v0.2.7
+
+* `Job#documents!` now updates job status
+
+## v0.2.6
+
+* Minor `Job` and `Document` fixes
+
+## v0.2.5
+
+* `Document` now parses `outputs` to `Storage::File` object
+* `Document` now has `output_formats` with corresponding parser
+* `Document#convert!` URI was changed
+* Job API methods were returning job documents in different format
+
+## v0.2.4
+
+* `Job` has now more attributes
+* `Job#documents=` should not raise error when `nil` is passed
+* Timestamps are being returned in milliseconds, while we were parsing them as seconds
+
+## v0.2.3
+
+* Fixed `Entity#variable_to_accessor` bugs
+* Updated `Document#fields!` to always include geometry
+* Added more accessors to `Rectange` (fixes `#inspect` issues)
+
+## v0.2.2
+
+* Updated `Folder.list!` for response changes
+
+## v0.2.1
+
+* `Sugar` namespace is now `Extensions`
+* Removed `File#delete!` workaround
+
+## v0.2
+
+* `File#compress!` supports only zip, so parameter was removed
+* `Errors` namespace was removed
+* `BadRequestError` now shows only error message
+* `File#upload!` no longer uses description, so parameter was removed
+* Added `File#file_type`
+* Added `File::DOCUMENT_TYPES`. `File#type` now returns document type in human-readable format
+* `Folder#list!` capitalizes `:order_by` option
+* Introduced `URLHelper#normalize_path`. Path is now normalized before sending request.
+* HTTP methods as strings are now allowed
+* Workaround for `File#delete!`
+* Updated gems
+
+## v0.1
+
+Initial release

data/README.md

@@ -36,8 +36,8 @@ GroupDocs.configure do |groupdocs|
   groupdocs.client_id = 'your_client_id'
   groupdocs.private_key = 'your_private_key'
   # optionally specify API server and version
-  groupdocs.api_server = 'https://dev-api.groupdocs.com'
-  groupdocs.api_version = '2.0'
+  groupdocs.api_server = 'https://dev-api.groupdocs.com' # default is 'https://api.groupdocs.com'
+  groupdocs.api_version = '3.0' # default is '2.0'
 end
 
 GroupDocs::Storage::Folder.create!('/folder')
@@ -49,11 +49,12 @@ You can also pass access credentials to particular requests
 ```ruby
 GroupDocs::Storage::Folder.create!('/folder', client_id: 'your_client_id', private_key: 'your_private_key')
 #=> #<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="folder", @url="http://groupdocs.com">
-
-GroupDocs::Document.find!(:name, 'CV.doc', client_id: 'your_client_id', private_key: 'your_private_key')
-#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="Folder1", @url="http://groupdocs.com">
 ```
 
+### Documentation
+
+Reference to [this page](http://rubydoc.info/gems/groupdocs) for docs
+
 ### Entities
 
 All entities can be initialized in several ways.
@@ -83,59 +84,6 @@ end
 #=> #<GroupDocs::Storage::Folder:0x0000000171f432 @name="Folder">
 ```
 
-### Find entities
-
-Some entities support `#all!`, `#find!` and `#find_all!` methods. You can pass any attribute that object responds to and its value to find with.
-
-* List all files
-
-```ruby
-GroupDocs::Storage::File.all!
-#=> [#<GroupDocs::Storage::File:0x0000000171f432 @id=123, @guid="uhfsa9dry29rhfodn", @name="resume.pdf", @url="http://groupdocs.com">, #<GroupDocs::Storage::File:0x0000000171f498 @id=456, @guid="soif97sr9u24bfosd9", @name="CV.doc", @url="http://groupdocs.com">]
-```
-
-* Find folder with name `Folder1`
-
-```ruby
-GroupDocs::Storage::Folder.find!(:name, 'Folder1')
-#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="Folder1", @url="http://groupdocs.com">
-```
-
-* Find all folders which name starts with `Folder`
-
-```ruby
-GroupDocs::Storage::Folder.find_all!(:name, /^Folder/)
-#=> [#<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="Folder1", @url="http://groupdocs.com">, #<GroupDocs::Storage::Folder:0x0000000171f467 @id=2, @name="Folder2", @url="http://groupdocs.com">]
-```
-
-### Annotation API
-
-Read more about examples of using Annotation API on [wiki](https://github.com/p0deje/groupdocs-ruby/wiki/Annotation-API).
-
-### Assembly API
-
-Read more about examples of using Assembly API on [wiki](https://github.com/p0deje/groupdocs-ruby/wiki/Assembly-API).
-
-### Comparison API
-
-Read more about examples of using Comparison API on [wiki](https://github.com/p0deje/groupdocs-ruby/wiki/Comparison-API).
-
-### Document API
-
-Read more about examples of using Document API on [wiki](https://github.com/p0deje/groupdocs-ruby/wiki/Document-API).
-
-### Job API
-
-Read more about examples of using Job API on [wiki](https://github.com/p0deje/groupdocs-ruby/wiki/Job-API).
-
-### Signature API
-
-Not yet implemented.
-
-### Storage API
-
-Read more about examples of using Storage API on [wiki](https://github.com/p0deje/groupdocs-ruby/wiki/Storage-API).
-
 ### Copyright
 
 Copyright (c) 2012 Aspose Inc.

data/Rakefile

@@ -2,7 +2,7 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new do |spec|
-  spec.rspec_opts = %w(--color)
+  spec.rspec_opts = %w(--color --require fuubar --format Fuubar)
   spec.pattern = 'spec/**/*_spec.rb'
 end
 

data/examples/README.md

@@ -0,0 +1,13 @@
+## Examples
+
+### Annotations
+
+Grab the copy of examples
+
+    gem install bundler # unless it's already installed
+    git clone git@github.com:groupdocs/groupdocs-ruby.git
+    cd groupdocs-ruby/examples/annotations
+    bundle install --path vendor/bundle
+    bundle exec ruby app.rb
+
+Now open `http://localhost:4567` and try it!

data/examples/annotations/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem 'sinatra'
+gem 'groupdocs'
+gem 'haml'

data/examples/annotations/app.rb

@@ -0,0 +1,67 @@
+require 'sinatra'
+require 'groupdocs'
+require 'haml'
+
+GroupDocs.api_version = '2.0'
+
+get '/' do
+  haml :upload
+end
+
+post '/upload' do
+  set :client_id, params[:client_id]
+  set :private_key, params[:private_key]
+  filepath = "#{Dir.tmpdir}/#{params[:file][:filename]}"
+  File.open(filepath, 'wb') { |f| f.write(params[:file][:tempfile].read) }
+  @@file = GroupDocs::Storage::File.upload!(filepath, '/', client_id: options.client_id, private_key: options.private_key)
+
+  haml :annotations
+end
+
+get '/annotations' do
+  annotations = @@file.to_document.annotations!(client_id: options.client_id, private_key: options.private_key)
+  annotations.map { |annotation| "Annotation Type: #{annotation.type} -- Replies: #{annotation.replies.map { |reply| "'#{reply.user_name}':'#{reply.text}'" }}" }.join "<br />"
+end
+
+
+__END__
+
+@@layout
+%html
+  %head
+    %title GroupDocs Ruby SDK Annotations Sample App
+    %script{ src: "http://rightjs.org/hotlink/right.js" }
+    :javascript
+      "#annotations".onClick(function(event) {
+        event.stop();
+        $('annotations_list').load("/annotations");
+      });
+  %body
+    = yield
+
+@@upload
+%h4 Upload file
+%form{ action: '/upload', method: 'post', enctype: 'multipart/form-data' }
+  %label{ for: 'client_id' } GroupDocs Client ID
+  %br
+  %input{ type: 'text', name: 'client_id' }
+  %br
+  %label{ for: 'private_key' } GroupDocs Private Key
+  %br
+  %input{ type: 'text', name: 'private_key' }
+  %br
+  %label{ for: 'file' } File
+  %br
+  %input{ type: 'file', name: 'file' }
+  %br
+  %br
+  %input{ type: 'submit', value: 'Upload' }
+
+@@annotations
+%iframe{ src: "https://apps.groupdocs.com/document-annotation/Embed/#{@@file.guid}", frameborder: 0, width: 720, height: 600 }
+%br
+%br
+%button#annotations Poll annotations
+%br
+%br
+#annotations_list

data/groupdocs.gemspec

@@ -1,5 +1,5 @@
 $LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
-require "groupdocs/version"
+require 'groupdocs/version'
 
 Gem::Specification.new do |s|
   s.name        = 'groupdocs'
@@ -17,9 +17,9 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'rest-client', '~> 1.6'
   s.add_runtime_dependency 'json'       , '~> 1.7'
-  s.add_runtime_dependency 'ruby-hmac'  , '~> 0.4'
 
-  s.add_development_dependency 'rspec'    , '~> 2.9'
+  s.add_development_dependency 'rspec'    , '~> 2.11'
+  s.add_development_dependency 'fuubar'   , '~> 1.1'
   s.add_development_dependency 'rake'     , '~> 0.9'
   s.add_development_dependency 'simplecov', '~> 0.6'
   s.add_development_dependency 'yard'     , '~> 0.8'

data/lib/groupdocs.rb

@@ -1,13 +1,13 @@
-require 'rest-client'
 require 'groupdocs/version'
 require 'groupdocs/errors'
 require 'groupdocs/api'
-require 'groupdocs/extensions'
 require 'groupdocs/datasource'
 require 'groupdocs/document'
 require 'groupdocs/job'
 require 'groupdocs/questionnaire'
+require 'groupdocs/signature'
 require 'groupdocs/storage'
+require 'groupdocs/subscription'
 require 'groupdocs/user'
 
 module GroupDocs
@@ -34,6 +34,15 @@ module GroupDocs
       @api_server || 'https://api.groupdocs.com'
     end
 
+    #
+    # Returns version of API.
+    #
+    # @return [String] API version. Default one if it has not been explicitly set
+    #
+    def api_version
+      @api_version || '2.0'
+    end
+
     #
     # Calls block for configuration of GroupDocs.
     #

data/lib/groupdocs/api/entity.rb

@@ -47,7 +47,7 @@ module GroupDocs
       def to_hash
         hash = {}
         instance_variables.each do |variable|
-          key = variable_to_accessor(variable)
+          key = variable.to_s.delete(?@).to_sym
           value = instance_variable_get(variable)
 
           hash[key] = case value
@@ -121,6 +121,22 @@ module GroupDocs
         "@#{word}".to_sym
       end
 
+      #
+      # Returns class name.
+      # @api private
+      #
+      def class_name
+        self.class.name.split('::').last.downcase
+      end
+
+      #
+      # Returns pluralized class name.
+      # @api private
+      #
+      def pluralized_class_name
+        "#{class_name}s"
+      end
+
     end # Entity
   end # Api
 end # GroupDocs

data/lib/groupdocs/api/helpers/path_helper.rb

@@ -4,22 +4,22 @@ module GroupDocs
       module Path
 
         #
-        # Verifies path starts with root.
+        # Make helper methods accessible as class methods as well
         #
-        # @raise [ArgumentError] If path does not start with /
-        # @api private
-        #
-        def self.verify_starts_with_root(path)
-          path.chars.first == '/' or raise ArgumentError, "Path should start with /: #{path.inspect}"
+        def self.included(klass)
+          klass.extend self
         end
 
+        private
+
         #
-        # Appends file name to path if it's not present.
-        #
+        # Prepares path.
+        # @param [String] path
+        # @return [String]
         # @api private
         #
-        def self.append_file_name(path, name)
-          path << "/#{Object::File.basename(name)}" unless /\.(\w){3,4}$/ === path
+        def prepare_path(path)
+          path.sub(%r(^/), '').gsub(%r(//+), '/')
         end
 
       end # Path