groupdocs 0.1.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,141 @@
+## GroupDocs [![Build Status](https://secure.travis-ci.org/p0deje/groupdocs-ruby.png)](http://travis-ci.org/p0deje/groupdocs-ruby)
+
+Ruby SDK for [GroupDocs](http://groupdocs.com) REST API.
+
+## Installation
+
+GroupDocs requires Ruby 1.9. Ruby 1.8 is not supported!
+
+Install as usually
+
+    gem install groupdocs
+
+Installing from source
+
+    gem install bundler # unless it's already installed
+    git clone git@github.com:p0deje/groupdocs-ruby.git
+    cd groupdocs-ruby/
+    git checkout master
+    bundle install --path vendor/bundle
+    bundle exec rake install
+
+## Usage
+
+All "bang" methods (ending with exclamation sign) imply interaction with API server.
+
+Other methods (with expect to some methods - see documentation) do not operate with API Server
+
+### Configuration
+
+First of all you need to configure your access to API server.
+
+```ruby
+require 'groupdocs'
+
+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'
+end
+
+GroupDocs::Storage::Folder.create!('/folder')
+#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="folder", @url="http://groupdocs.com">
+```
+
+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">
+```
+
+### Entities
+
+All entities can be initialized in several ways.
+
+* Object is created, attributes are set later.
+
+```ruby
+folder = GroupDocs::Storage::Folder.new
+folder.name = 'Folder'
+folder.inspect
+#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @name="Folder">
+```
+
+* Hash of attributes are passed to object constructor.
+
+```ruby
+GroupDocs::Storage::Folder.new(name: 'Folder')
+#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @name="Folder">
+```
+
+* Block is passed to object constructor.
+
+```ruby
+GroupDocs::Storage::Folder.new do |folder|
+  folder.name = 'Folder'
+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

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |spec|
+  spec.rspec_opts = %w(--color)
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task default: :spec

data/groupdocs.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+require "groupdocs/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'groupdocs'
+  s.version     = GroupDocs::VERSION
+  s.authors     = 'Alex Rodionov'
+  s.email       = 'p0deje@gmail.com'
+  s.homepage    = 'https://github.com/p0deje/groupdocs-ruby'
+  s.summary     = 'Ruby SDK for GroupDocs REST API'
+  s.description = 'Ruby SDK for GroupDocs REST API'
+
+  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_path = 'lib'
+
+  s.add_runtime_dependency 'rest-client', '~> 1.6'
+  s.add_runtime_dependency 'json'       , '~> 1.6'
+  s.add_runtime_dependency 'ruby-hmac'  , '~> 0.4'
+
+  s.add_development_dependency 'rspec'    , '~> 2.9'
+  s.add_development_dependency 'rake'     , '~> 0.9'
+  s.add_development_dependency 'simplecov', '~> 0.6'
+  s.add_development_dependency 'yard'     , '~> 0.7'
+  s.add_development_dependency 'webmock'  , '~> 1.8'
+end

data/lib/groupdocs.rb

@@ -0,0 +1,53 @@
+require 'groupdocs/version'
+require 'groupdocs/errors'
+require 'groupdocs/api'
+require 'groupdocs/datasource'
+require 'groupdocs/document'
+require 'groupdocs/job'
+require 'groupdocs/questionnaire'
+require 'groupdocs/storage'
+require 'groupdocs/user'
+
+module GroupDocs
+  class << self
+
+    # @attr [String] client_id Client ID
+    attr_accessor :client_id
+
+    # @attr [String] private_key Private key
+    attr_accessor :private_key
+
+    # @attr [String] api_server API server
+    attr_accessor :api_server
+
+    # @attr [String] api_version Version of API server
+    attr_accessor :api_version
+
+    #
+    # Returns hostname of API server.
+    #
+    # @return [String] API hostname. Default one if it has not been explicitly set
+    #
+    def api_server
+      @api_server || 'https://api.groupdocs.com'
+    end
+
+    #
+    # Calls block for configuration of GroupDocs.
+    #
+    # @example
+    #   GroupDocs.configure do |groupdocs|
+    #     groupdocs.client_id = '07aaaf95f8eb33a4'
+    #     groupdocs.private_key = '5cb711b3a52ffc5d90ee8a0f79206f5a'
+    #     groupdocs.api_server = 'https://api.groupdocs.com'
+    #     groupdocs.api_version = '2.0'
+    #   end
+    #
+    # @yield [GroupDocs]
+    #
+    def configure(&blk)
+      yield self
+    end
+
+  end # << self
+end # GroupDocs

data/lib/groupdocs/api.rb

@@ -0,0 +1,3 @@
+require 'groupdocs/api/entity'
+require 'groupdocs/api/request'
+require 'groupdocs/api/sugar/lookup'

data/lib/groupdocs/api/entity.rb

@@ -0,0 +1,113 @@
+module GroupDocs
+  module Api
+    class Entity
+
+      #
+      # Implements flexible API object creation.
+      #
+      # You can pass hash of options to automatically set attributes.
+      #
+      # @example Create folder with options hash
+      #   GroupDocs::Storage::Folder.new(id: 1, name 'Test', url: 'http://groupdocs.com/folder/test')
+      #   #=> <#GroupDocs::Storage::Folder @id=1 @name="Test" @url="http://groupdocs.com/folder/test">
+      #
+      # You can also pass block to set up attributes.
+      #
+      # @example Create folder with block
+      #   GroupDocs::Storage::Folder.new do |folder|
+      #     folder.id = 1
+      #     folder.name = 'Test'
+      #     folder.url = 'http://groupdocs.com/folder/test'
+      #   end
+      #   #=> <#GroupDocs::Storage::Folder @id=1 @name="Test" @url="http://groupdocs.com/folder/test">
+      #
+      # @param [Hash] options Each option is object attribute
+      # @yield [self] Use block to set up attributes
+      #
+      def initialize(options = {}, &blk)
+        if options.empty?
+          yield self if block_given?
+        else
+          options.each do |attr, value|
+            send(:"#{attr}=", value) if respond_to?(:"#{attr}=")
+          end
+        end
+      end
+
+      #
+      # Recursively converts object and all its attributes to hash.
+      #
+      # @example Convert simple object to hash
+      #   object = GroupDocs::Storage::File.new(id: 1, name, 'Test.pdf')
+      #   object.to_hash
+      #   #=> { id: 1, name: 'Test.pdf' }
+      #
+      # @return [Hash]
+      #
+      def to_hash
+        hash = {}
+        instance_variables.each do |variable|
+          key = variable_to_accessor(variable)
+          value = instance_variable_get(variable)
+
+          hash[key] = case value
+                      when GroupDocs::Api::Entity
+                        value.to_hash
+                      when Array
+                        value.map do |i|
+                          i.to_hash if i.respond_to?(:to_hash)
+                        end
+                      else
+                        value
+                      end
+        end
+
+        hash
+      end
+
+      #
+      # Inspects object using accessors instead of instance variables values.
+      #
+      # @api private
+      #
+      def inspect
+        not_nil_variables = instance_variables.select do |variable|
+          !send(variable_to_accessor(variable)).nil?
+        end
+
+        variables = not_nil_variables.map  do |variable|
+          accessor = variable_to_accessor(variable)
+          value = send(accessor)
+          value = case value
+                  when Symbol then ":#{value}"
+                  when String then "\"#{value}\""
+                  else value
+                  end
+          "@#{accessor}=#{value}"
+        end
+
+        inspected = self.to_s
+        unless variables.empty?
+          inspected.gsub!(/>$/, '')
+          inspected << " #{variables.join(', ')}"
+          inspected << ?>
+        end
+
+        inspected
+      end
+
+      private
+
+      #
+      # Converts instance variable symbol to accessor method symbol.
+      # @api private
+      #
+      def variable_to_accessor(variable)
+        word = variable.to_s.delete(?@)
+        word.gsub!(/[A-Z]/) { |letter| "_#{letter.downcase}" }
+        word.to_sym
+      end
+
+    end # Entity
+  end # Api
+end # GroupDocs

data/lib/groupdocs/api/helpers.rb

@@ -0,0 +1,5 @@
+require 'groupdocs/api/helpers/access_helper'
+require 'groupdocs/api/helpers/actions_helper'
+require 'groupdocs/api/helpers/rest_helper'
+require 'groupdocs/api/helpers/status_helper'
+require 'groupdocs/api/helpers/url_helper'

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

@@ -0,0 +1,56 @@
+module GroupDocs
+  module Api
+    module Helpers
+      module Access
+
+        MODES = {
+          private:    0,
+          restricted: 1,
+          public:     2
+        }
+
+        private
+
+        #
+        # Returns client ID from access hash or GroupDocs class variable.
+        #
+        # @return [String]
+        # @raise [NoClientIdError] If Client ID hasn't been set yet, raise exception.
+        # @api private
+        #
+        def client_id
+          client_id = options[:access][:client_id] || GroupDocs.client_id
+          client_id or raise Errors::NoClientIdError, 'Client ID has not been specified.'
+        end
+
+        #
+        # Returns private key from access hash or GroupDocs class variable.
+        #
+        # @return [String]
+        # @raise [NoPrivateKeyError] If private key hasn't been set yet, raise exception.
+        # @api private
+        #
+        def private_key
+          private_key = options[:access][:private_key] || GroupDocs.private_key
+          private_key or raise Errors::NoPrivateKeyError, 'Private Key has not been specified.'
+        end
+
+        #
+        # Converts access mode from/to human-readable format.
+        #
+        # @param [Integer, Symbol] mode
+        # @return [Symbol, Integer]
+        # @api private
+        #
+        def parse_access_mode(mode)
+          if mode.is_a?(Integer)
+            MODES.invert[mode]
+          else
+            MODES[mode]
+          end or raise ArgumentError, "Unknown access mode: #{mode.inspect}."
+        end
+
+      end # Access
+    end # Helpers
+  end # Api
+end # GroupDocs

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

@@ -0,0 +1,48 @@
+module GroupDocs
+  module Api
+    module Helpers
+      module Actions
+
+        ACTIONS = {
+          none:                 0,
+          convert:              1,
+          combine:              2,
+          compress_zip:         4,
+          compress_rar:         8,
+          trace:               16,
+          convert_body:        32,
+          bind_data:           64,
+          print:              128,
+          import_annotations: 256,
+        }
+
+        #
+        # Converts actions array to byte flag.
+        #
+        # @param [Array<String, Symbol>] actions
+        # @return [Integer]
+        # @raise [ArgumentError] if actions is not an array
+        # @raise [ArgumentError] if action is unknown
+        # @api private
+        #
+        def convert_actions(actions)
+          actions.is_a?(Array) or raise ArgumentError, "Actions should be an array, received: #{actions.inspect}"
+          actions = actions.map(&:to_sym)
+
+          possible_actions = ACTIONS.map { |hash| hash.first }
+          actions.each do |action|
+            possible_actions.include?(action) or raise ArgumentError, "Unknown action: #{action.inspect}"
+          end
+
+          flag = 0
+          actions.each do |action|
+            flag += ACTIONS[action]
+          end
+
+          flag
+        end
+
+      end # Actions
+    end # Helpers
+  end # Api
+end # GroupDocs