groupdocs 0.1.0

data/lib/groupdocs/storage/folder.rb

@@ -0,0 +1,314 @@
+module GroupDocs
+  module Storage
+    class Folder < GroupDocs::Api::Entity
+
+      extend GroupDocs::Api::Sugar::Lookup
+      include GroupDocs::Api::Helpers::Access
+
+      #
+      # Creates folder on server.
+      #
+      # @param [String] path Path of folder to create starting with "/"
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [GroupDocs::Storage::Folder] Created folder
+      #
+      # @raise [ArgumentError] If path does not start with /
+      #
+      def self.create!(path, access = {})
+        path.chars.first == '/' or raise ArgumentError, "Path should start with /: #{path.inspect}"
+
+        json = GroupDocs::Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :POST
+          request[:path] = "/storage/{{client_id}}/paths#{path}"
+        end.execute!
+
+        GroupDocs::Storage::Folder.new(json)
+      end
+
+      #
+      # Returns an array of all folders on server starting with given path.
+      #
+      # @param [String] path Starting path to look for folders
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [Array<GroupDocs::Storage::Folder>]
+      #
+      def self.all!(path = '/', access = {})
+        folders = Array.new
+        folder = GroupDocs::Storage::Folder.new(path: path)
+        folder.list!({}, access).each do |entity|
+          if entity.is_a?(GroupDocs::Storage::Folder)
+            folders << entity
+            folders += all!("#{path}/#{entity.name}".gsub(/[\/]{2}/, '/'), access)
+          end
+        end
+
+        folders
+      end
+
+      #
+      # Returns a list of all directories and files in the path.
+      #
+      # @param [String] path Path of directory to list starting from root ('/')
+      # @param [Hash] options Hash of options
+      # @option options [Integer] :page Page to start with
+      # @option options [Integer] :count How many items to list
+      # @option options [String] :order_by Field name to sort by
+      # @option options [Boolean] :order_asc Set to true to return in ascending order
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [Array<GroupDocs::Storage::Folder, GroupDocs::Storage::File>]
+      #
+      # @raise [ArgumentError] If path does not start with /
+      #
+      def self.list!(path = '/', options = {}, access = {})
+        path.chars.first == '/' or raise ArgumentError, "Path should start with /: #{path.inspect}"
+        new(path: path).list!(options, access)
+      end
+
+      # @attr [Integer] id
+      attr_accessor :id
+      # @attr [Integer] size
+      attr_accessor :size
+      # @attr [Integer] folder_count
+      attr_accessor :folder_count
+      # @attr [Integer] file_count
+      attr_accessor :file_count
+      # @attr [Time] created_on
+      attr_accessor :created_on
+      # @attr [Time] modified_on
+      attr_accessor :modified_on
+      # @attr [String] url
+      attr_accessor :url
+      # @attr [String] name
+      attr_accessor :name
+      # @attr [String] path
+      attr_accessor :path
+      # @attr [Integer] version
+      attr_accessor :version
+      # @attr [Integer] type
+      attr_accessor :type
+      # @attr [Integer] access
+      attr_accessor :access
+
+      #
+      # Converts timestamp which is return by API server to Time object.
+      #
+      # @return [Time]
+      #
+      def created_on
+        Time.at(@created_on)
+      end
+
+      #
+      # Converts timestamp which is return by API server to Time object.
+      #
+      # @return [Time]
+      #
+      def modified_on
+        Time.at(@modified_on)
+      end
+
+      #
+      # Converts access mode to human-readable format.
+      #
+      # @return [Symbol]
+      #
+      def access
+        parse_access_mode(@access)
+      end
+
+      #
+      # Moves folder contents to given path.
+      #
+      # @param [String] path Destination to move contents to
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [String] Moved to folder path
+      #
+      # @raise [ArgumentError] If path does not start with /
+      #
+      def move!(path, access = {})
+        path.chars.first == '/' or raise ArgumentError, "Path should start with /: #{path.inspect}"
+
+        GroupDocs::Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :PUT
+          request[:headers] = { :'Groupdocs-Move' => name }
+          request[:path] = "/storage/{{client_id}}/folders#{path}"
+        end.execute!
+
+        path
+      end
+
+      #
+      # Renames folder to new one.
+      #
+      # @param [String] name New name
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [String] New name
+      #
+      def rename!(name, access = {})
+        move!("/#{name}", access).sub(/^\//, '')
+      end
+
+      #
+      # Copies folder contents to a destination path.
+      #
+      # @param [String] path Path of directory to copy to starting from root ('/')
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [String] Copied to folder path
+      #
+      # @raise [ArgumentError] If path does not start with /
+      #
+      def copy!(path, access = {})
+        path.chars.first == '/' or raise ArgumentError, "Path should start with /: #{path.inspect}"
+
+        GroupDocs::Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :PUT
+          request[:headers] = { :'Groupdocs-Copy' => name }
+          request[:path] = "/storage/{{client_id}}/folders#{path}"
+        end.execute!
+
+        path
+      end
+
+      #
+      # Returns an array of files and folders.
+      #
+      # @param [Hash] options Hash of options
+      # @option options [Integer] :page Page to start with
+      # @option options [Integer] :count How many items to list
+      # @option options [String] :order_by Field name to sort by
+      # @option options [Boolean] :order_asc Set to true to return in ascending order
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [Array<GroupDocs::Storage::Folder, GroupDocs::Storage::File>]
+      #
+      def list!(options = {}, access = {})
+        query_path = "#{path}/#{name}"
+        query_path.gsub!(/[\/]{2}/, '/')
+
+        api = GroupDocs::Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :GET
+          request[:path] = "/storage/{{client_id}}/folders#{query_path}"
+        end
+        api.add_params(options)
+        json = api.execute!
+
+        json[:entities].map do |entity|
+          entity.merge!(path: path)
+          if entity[:dir]
+            GroupDocs::Storage::Folder.new(entity)
+          else
+            GroupDocs::Storage::File.new(entity)
+          end
+        end
+      end
+
+      #
+      # Creates folder on server.
+      #
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      #
+      def create!(access = {})
+        self.class.create!("/#{name}", access)
+      end
+
+      #
+      # Deletes folder from server.
+      #
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      #
+      def delete!(access = {})
+        GroupDocs::Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :DELETE
+          request[:path] = "/storage/{{client_id}}/folders/#{name}"
+        end.execute!
+      end
+
+      #
+      # Returns an array of users a folder is shared with.
+      #
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [Array<GroupDocs::User>]
+      #
+      def sharers!(access = {})
+        json = GroupDocs::Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :GET
+          request[:path] = "/doc/{{client_id}}/folders/#{id}/sharers"
+        end.execute!
+
+        json[:shared_users].map do |user|
+          GroupDocs::User.new(user)
+        end
+      end
+
+      #
+      # Sets folder sharers to given emails.
+      #
+      # If empty array or nil passed, clears sharers.
+      #
+      # @param [Array] emails List of email addresses to share with
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [Array<GroupDocs::User>]
+      #
+      def sharers_set!(emails, access = {})
+        if emails.nil? || emails.empty?
+          sharers_clear!(access)
+        else
+          json = GroupDocs::Api::Request.new do |request|
+            request[:access] = access
+            request[:method] = :PUT
+            request[:path] = "/doc/{{client_id}}/folders/#{id}/sharers"
+            request[:request_body] = emails
+          end.execute!
+
+          json[:shared_users].map do |user|
+            GroupDocs::User.new(user)
+          end
+        end
+      end
+
+      #
+      # Clears sharers list.
+      #
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return nil
+      #
+      def sharers_clear!(access = {})
+        GroupDocs::Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :DELETE
+          request[:path] = "/doc/{{client_id}}/folders/#{id}/sharers"
+        end.execute![:shared_users]
+      end
+
+    end # Folder
+  end # Storage
+end # GroupDocs

data/lib/groupdocs/storage/package.rb

@@ -0,0 +1,42 @@
+module GroupDocs
+  module Storage
+    class Package < GroupDocs::Api::Entity
+
+      # @attr [String] name Package name
+      attr_accessor :name
+      # @attr [Array] objects Storage entities to be packed
+      attr_accessor :objects
+
+      #
+      # Appends object to be packed.
+      #
+      # @param [GroupDocs::Storage::File, GroupDocs::Storage::Folder] object
+      #
+      def add(object)
+        @objects ||= Array.new
+        @objects << object
+      end
+      alias_method :<<, :add
+
+      #
+      # Creates package on server.
+      #
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [String] URL of package for downloading
+      #
+      def create!(access = {})
+        json = GroupDocs::Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :POST
+          request[:path] = "/storage/{{client_id}}/packages/#{name}.zip"
+          request[:request_body] = @objects.map(&:name)
+        end.execute!
+
+        json[:url]
+      end
+
+    end # Package
+  end # Storage
+end # GroupDocs

data/lib/groupdocs/user.rb

@@ -0,0 +1,50 @@
+module GroupDocs
+  class User < GroupDocs::Api::Entity
+
+    # @attr [Integer] id
+    attr_accessor :id
+    # @attr [String] guid
+    attr_accessor :guid
+    # @attr [String] nickname
+    attr_accessor :nickname
+    # @attr [String] first_name
+    attr_accessor :first_name
+    # @attr [String] last_name
+    attr_accessor :last_name
+    # @attr [String] primary_email
+    attr_accessor :primary_email
+    # @attr [String] private_key
+    attr_accessor :private_key
+    # @attr [String] password_salt
+    attr_accessor :password_salt
+    # @attr [Integer] claimed_id
+    attr_accessor :claimed_id
+    # @attr [String] token
+    attr_accessor :token
+    # @attr [String] storage
+    attr_accessor :storage
+    # @attr [String] photo
+    attr_accessor :photo
+    # @attr [Boolean] active
+    attr_accessor :active
+    # @attr [Boolean] news_enabled
+    attr_accessor :news_enabled
+    # @attr [Time] signed_up_on
+    attr_accessor :signed_up_on
+
+    #
+    # Converts timestamp which is return by API server to Time object.
+    #
+    # @return [Time]
+    #
+    def signed_up_on
+      Time.at(@signed_up_on)
+    end
+
+    # Compatibility with response JSON
+    alias_method :pkey=,       :private_key=
+    alias_method :pswd_salt=,  :password_salt=
+    alias_method :signedupOn=, :signed_up_on=
+
+  end # User
+end # GroupDocs

data/lib/groupdocs/version.rb

@@ -0,0 +1,3 @@
+module GroupDocs
+  VERSION = "0.1.0"
+end # GroupDocs

data/spec/groupdocs/api/entity_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe GroupDocs::Api::Entity do
+  before(:each) do
+    # make sure necessary attribute exist
+    described_class.class_eval('attr_accessor :id, :test')
+    subject.id = 1
+  end
+
+  describe '#to_hash' do
+    it 'converts object attributes to hash' do
+      subject.test = 'Test'
+      subject.to_hash.should == { id: 1, test: 'Test' }
+    end
+
+    it 'converts attribute to hash if it is object' do
+      object = described_class.new(id: 1)
+      object.should_receive(:to_hash).and_return({ id: 1 })
+      subject.test = object
+      subject.to_hash.should == { id: 1, test: { id: 1 } }
+    end
+
+    it 'converts attribute to hash if it is array' do
+      object1 = described_class.new(id: 1)
+      object2 = described_class.new(id: 2)
+      object1.should_receive(:to_hash).and_return({ id: 1 })
+      object2.should_receive(:to_hash).and_return({ id: 2 })
+      subject.test = [object1, object2]
+      subject.to_hash.should == { id: 1, test: [{ id: 1 }, { id: 2 }] }
+    end
+  end
+
+  describe '#inspect' do
+    it 'uses accessors instead of instance variables' do
+      subject.instance_variable_set(:@test1, 1)
+      subject.instance_variable_set(:@test2, 1)
+      subject.instance_eval('def test1; { fire: 1 }.invert[@test1] end')
+      subject.instance_eval('def test2; { 1 => "fire" }[@test2] end')
+      subject.inspect.should include('@test1=:fire')
+      subject.inspect.should include('@test2="fire"')
+    end
+
+    it 'uses only not-nil instance variables' do
+      subject.instance_variable_set(:@test, nil)
+      subject.inspect.should_not include('@test')
+    end
+  end
+
+  describe '#variable_to_accessor' do
+    it 'converts instance variable symbol to accessor method symbol' do
+      subject.send(:variable_to_accessor, :@test).should == :test
+    end
+  end
+end