groupdocs 0.3.11 → 1.0.0

data/lib/groupdocs/subscription.rb

@@ -0,0 +1,113 @@
+module GroupDocs
+  class Subscription < Api::Entity
+
+    require 'groupdocs/subscription/limit'
+
+    LIMITS = {
+      annotations_limit:      'AnnotationsLimit',
+      apicalls:               'APICalls',
+      apiemails:              'APIEmails',
+      assembly_limit:         'AssemblyLimit',
+      branded:                'Branded',
+      comparison_limit:       'ComparisonLimit',
+      conversion_limit:       'ConversionLimit',
+      documents_limit:        'DocumentsLimit',
+      document_history_limit: 'DocumentHistoryLimit',
+      document_size_limit:    'DocumentSizeLimit',
+      document_tokens_limit:  'DocumentTokensLimit',
+      sharing_limit:          'SharingLimit',
+      signature_limit:        'SignatureLimit',
+      storage_space_limit:    'StorageSpaceLimit',
+      users_limit:            'UsersLimit',
+    }
+
+    #
+    # Returns current subscription plan.
+    #
+    # @example
+    #   GroupDocs::Subscription.current!.name
+    #   #=> 'Free'
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Subscription]
+    #
+    def self.current!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/system/{{client_id}}/plan'
+      end.execute!
+
+      new(json)
+    end
+
+    #
+    # Returns all subscription plans for family.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Subscription>]
+    #
+    def self.list!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/system/{{client_id}}/plans/groupdocs'
+      end.execute!
+
+      json[:metrics].map do |plan|
+        new(plan)
+      end
+    end
+
+    # @attr [Integer] Id
+    attr_accessor :Id
+    # @attr [String] Name
+    attr_accessor :Name
+    # @attr [Integer] PricingPlanId
+    attr_accessor :PricingPlanId
+    # @attr [Integer] Price
+    attr_accessor :Price
+    # @attr [String] CurrencyCode
+    attr_accessor :CurrencyCode
+
+    # Human-readable accessors
+    alias_method :id,               :Id
+    alias_method :id=,              :Id=
+    alias_method :name,             :Name
+    alias_method :name=,            :Name=
+    alias_method :pricing_plan_id,  :PricingPlanId
+    alias_method :pricing_plan_id=, :PricingPlanId=
+    alias_method :price,            :Price
+    alias_method :price=,           :Price=
+    alias_method :currency_code,    :CurrencyCode
+    alias_method :currency_code=,   :CurrencyCode=
+
+    # Compatibility with response JSON
+    alias_method :ref_id=, :id=
+
+    #
+    # Dynamically generate accessors for existing subscription plan limits.
+    #
+    LIMITS.each do |snake, camel|
+      # @attr [GroupDocs::Subscription::Limit] limit
+      attr_accessor camel
+
+      # Human-readable accessors
+      alias_method :"#{snake}",  :"#{camel}"
+      alias_method :"#{snake}=", :"#{camel}="
+
+      #
+      # Converts hash to subscription plan limit.
+      # @return [GroupDocs::Subscription::Limit]
+      #
+      define_method(snake) do
+        Limit.new(instance_variable_get(:"@#{camel}"))
+      end
+    end
+
+  end # Subscription
+end # GroupDocs

data/lib/groupdocs/subscription/limit.rb

@@ -0,0 +1,24 @@
+module GroupDocs
+  class Subscription::Limit < Api::Entity
+
+    # @attr [Integer] Id
+    attr_accessor :Id
+    # @attr [Integer] Min
+    attr_accessor :Min
+    # @attr [Integer] Max
+    attr_accessor :Max
+    # @attr [String] Description
+    attr_accessor :Description
+
+    # Human-readable accessors
+    alias_method :id,           :Id
+    alias_method :id=,          :Id=
+    alias_method :min,          :Min
+    alias_method :min=,         :Min=
+    alias_method :max,          :Max
+    alias_method :max=,         :Max=
+    alias_method :description,  :Description
+    alias_method :description=, :Description=
+
+  end # Subscription::Limit
+end # GroupDocs

data/lib/groupdocs/user.rb

@@ -1,10 +1,10 @@
 module GroupDocs
-  class User < GroupDocs::Api::Entity
+  class User < Api::Entity
 
     #
     # Returns current user profile.
     #
-    # @example Get fill
+    # @example
     #   user = GroupDocs::User.get!
     #   user.first_name
     #   #=> "John"
@@ -97,5 +97,25 @@ module GroupDocs
       end.execute!
     end
 
+    #
+    # Returns an array of users associated to current user account.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::User>]
+    #
+    def users!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/mgmt/{{client_id}}/account/users'
+      end.execute!
+
+      json[:users].map do |user|
+        GroupDocs::User.new(user)
+      end
+    end
+
   end # User
 end # GroupDocs

data/lib/groupdocs/version.rb

@@ -1,3 +1,3 @@
 module GroupDocs
-  VERSION = '0.3.11'
+  VERSION = '1.0.0'
 end # GroupDocs

data/spec/groupdocs/api/entity_spec.rb

@@ -65,4 +65,18 @@ describe GroupDocs::Api::Entity do
       subject.send(:accessor_to_variable, :test_one_and_two).should == :@TestOneAndTwo
     end
   end
+
+  describe '#class_name' do
+    it 'returns downcased class name' do
+      object = GroupDocs::Storage::File.new
+      object.send(:class_name).should == 'file'
+    end
+  end
+
+  describe '#pluralized_class_name' do
+    it 'returns class name ending with s' do
+      object = GroupDocs::Storage::File.new
+      object.send(:pluralized_class_name).should == 'files'
+    end
+  end
 end

data/spec/groupdocs/api/helpers/path_helper_spec.rb

@@ -1,28 +1,15 @@
 require 'spec_helper'
 
 describe GroupDocs::Api::Helpers::Path do
+  subject { GroupDocs::Storage::File.new }
 
-  describe '.verify_starts_with_root' do
-    it 'does not raise error if path starts with /' do
-      -> { described_class.verify_starts_with_root('/Test') }.should_not raise_error(ArgumentError)
+  describe '#prepare_path' do
+    it 'removes first / from string' do
+      subject.send(:prepare_path, '/test').should == 'test'
     end
 
-    it 'raises error if path does not start with /' do
-      -> { described_class.verify_starts_with_root('Test') }.should raise_error(ArgumentError)
-    end
-  end
-
-  describe '.append_file_name' do
-    it 'does not change path if filename is present' do
-      path = '/upload_path/test.pdf'
-      described_class.append_file_name(path, __FILE__)
-      path.should == '/upload_path/test.pdf'
-    end
-
-    it 'appends filename to path if it is not passed' do
-      path = '/upload_path'
-      described_class.append_file_name(path, __FILE__)
-      path.should == "/upload_path/#{File.basename(__FILE__)}"
+    it 'removes two or more / from string' do
+      subject.send(:prepare_path, 'test1//test2///test3').should == 'test1/test2/test3'
     end
   end
 end

data/spec/groupdocs/api/helpers/rest_helper_spec.rb

@@ -79,6 +79,15 @@ describe GroupDocs::Api::Helpers::REST do
         subject.send(:prepare_request)
       end.should change { subject.options[:headers][:content_type] }.to('application/json')
     end
+
+    it 'allows sending payload as plain text' do
+      subject.options[:method] = :POST
+      subject.options[:request_body] = 'test'
+      subject.options[:plain] = true
+      subject.send(:prepare_request)
+      subject.options[:request_body].should == 'test'
+      subject.options[:headers][:content_type].should_not == 'application/json'
+    end
   end
 
   describe '#send_request' do

data/spec/groupdocs/api/request_spec.rb

@@ -40,17 +40,12 @@ describe GroupDocs::Api::Request do
   describe '#execute!' do
     before(:each) do
       GroupDocs.stub(private_key: 'private_key')
-      subject.options[:method] = :get
-      subject.options[:path] = '/folders'
+      subject.options[:method]  = :get
+      subject.options[:path]    = '/folders'
       subject.options[:headers] = {}
       mock_api_server('{"status":"Ok"}')
     end
 
-    it 'normalizes path' do
-      subject.should_receive(:normalize_path)
-      subject.execute!
-    end
-
     it 'parses path' do
       subject.should_receive(:parse_path)
       subject.execute!

data/spec/groupdocs/datasource_spec.rb

@@ -44,12 +44,8 @@ describe GroupDocs::DataSource do
   it { should respond_to(:fields)            }
   it { should respond_to(:fields=)           }
 
-  it 'has human-readable accessors' do
-    subject.should respond_to(:description)
-    subject.should respond_to(:description=)
-    subject.method(:description).should  == subject.method(:descr)
-    subject.method(:description=).should == subject.method(:descr=)
-  end
+  it { should have_alias(:description, :descr)   }
+  it { should have_alias(:description=, :descr=) }
 
   describe '#created_on' do
     it 'returns converted to Time object Unix timestamp' do
@@ -118,7 +114,7 @@ describe GroupDocs::DataSource do
       subject.add!
     end
 
-    it 'adds ID of datasource from response to self' do
+    it 'updates identifier of datasource' do
       lambda do
         subject.add!
       end.should change(subject, :id)

data/spec/groupdocs/document/annotation/reply_spec.rb

@@ -73,24 +73,15 @@ describe GroupDocs::Document::Annotation::Reply do
   it { should respond_to(:repliedOn)       }
   it { should respond_to(:repliedOn=)      }
 
-  it 'has human-readable accessors' do
-    subject.should respond_to(:annotation_guid)
-    subject.should respond_to(:annotation_guid=)
-    subject.should respond_to(:user_guid)
-    subject.should respond_to(:user_guid=)
-    subject.should respond_to(:user_name)
-    subject.should respond_to(:user_name=)
-    subject.should respond_to(:replied_on)
-    subject.should respond_to(:replied_on=)
-    subject.method(:annotation_guid).should  == subject.method(:annotationGuid)
-    subject.method(:annotation_guid=).should == subject.method(:annotationGuid=)
-    subject.method(:user_guid).should        == subject.method(:userGuid)
-    subject.method(:user_guid=).should       == subject.method(:userGuid=)
-    subject.method(:user_name).should        == subject.method(:userName)
-    subject.method(:user_name=).should       == subject.method(:userName=)
-    # Reply#replied_on is overwritten
-    subject.method(:replied_on=).should      == subject.method(:repliedOn=)
-  end
+  it { should have_alias(:annotation_guid, :annotationGuid)   }
+  it { should have_alias(:annotation_guid=, :annotationGuid=) }
+  it { should have_alias(:user_guid, :userGuid)               }
+  it { should have_alias(:user_guid=, :userGuid=)             }
+  it { should have_alias(:user_name, :userName)               }
+  it { should have_alias(:user_name=, :userName=)             }
+  # Reply#replied_on is overwritten
+  it { should have_alias(:replied_on=, :repliedOn=)           }
+
 
   describe '#initialize' do
     it 'raises error if annotation is not specified' do
@@ -137,7 +128,7 @@ describe GroupDocs::Document::Annotation::Reply do
 
   describe '#edit!' do
     before(:each) do
-      mock_api_server('{"result": {}, "status": "Ok", "error_message": null}')
+      mock_api_server('{ "result": {}, "status": "Ok" }')
     end
 
     it 'accepts access credentials hash' do
@@ -149,7 +140,7 @@ describe GroupDocs::Document::Annotation::Reply do
 
   describe '#remove!' do
     before(:each) do
-      mock_api_server('{"result": {}, "status": "Ok", "error_message": null}')
+      mock_api_server('{ "result": {}, "status": "Ok" }')
     end
 
     it 'accepts access credentials hash' do

data/spec/groupdocs/document/annotation_spec.rb

@@ -21,6 +21,8 @@ describe GroupDocs::Document::Annotation do
   it { should respond_to(:sessionGuid=)        }
   it { should respond_to(:documentGuid)        }
   it { should respond_to(:documentGuid=)       }
+  it { should respond_to(:creatorGuid)         }
+  it { should respond_to(:creatorGuid=)        }
   it { should respond_to(:replyGuid)           }
   it { should respond_to(:replyGuid=)          }
   it { should respond_to(:createdOn)           }
@@ -36,35 +38,21 @@ describe GroupDocs::Document::Annotation do
   it { should respond_to(:annotationPosition)  }
   it { should respond_to(:annotationPosition=) }
 
-  it 'has human-readable accessors' do
-    subject.should respond_to(:session_guid)
-    subject.should respond_to(:session_guid=)
-    subject.should respond_to(:document_guid)
-    subject.should respond_to(:document_guid=)
-    subject.should respond_to(:reply_guid)
-    subject.should respond_to(:reply_guid=)
-    subject.should respond_to(:created_on)
-    subject.should respond_to(:created_on=)
-    subject.should respond_to(:annotation_position)
-    subject.should respond_to(:annotation_position=)
-    subject.should respond_to(:position)
-    subject.method(:session_guid).should         == subject.method(:sessionGuid)
-    subject.method(:session_guid=).should        == subject.method(:sessionGuid=)
-    subject.method(:document_guid).should        == subject.method(:documentGuid)
-    subject.method(:document_guid=).should       == subject.method(:documentGuid=)
-    subject.method(:reply_guid).should           == subject.method(:replyGuid)
-    subject.method(:reply_guid=).should          == subject.method(:replyGuid=)
-    # Annotation#created_on is overwritten
-    subject.method(:created_on=).should          == subject.method(:createdOn=)
-    subject.method(:annotation_position).should  == subject.method(:annotationPosition)
-    subject.method(:annotation_position=).should == subject.method(:annotationPosition=)
-    subject.method(:position).should             == subject.method(:annotation_position)
-  end
-
-  it 'is compatible with response JSON' do
-    subject.should respond_to(:annotationGuid=)
-    subject.method(:annotationGuid=).should == subject.method(:guid=)
-  end
+  it { should have_alias(:session_guid, :sessionGuid)                 }
+  it { should have_alias(:session_guid=, :sessionGuid=)               }
+  it { should have_alias(:document_guid, :documentGuid)               }
+  it { should have_alias(:document_guid=, :documentGuid=)             }
+  it { should have_alias(:creator_guid, :creatorGuid)                 }
+  it { should have_alias(:creator_guid=, :creatorGuid=)               }
+  it { should have_alias(:reply_guid, :replyGuid)                     }
+  it { should have_alias(:reply_guid=, :replyGuid=)                   }
+  # Annotation#created_on is overwritten
+  it { should have_alias(:created_on=, :createdOn=)                   }
+  it { should have_alias(:annotation_position, :annotationPosition)   }
+  it { should have_alias(:annotation_position=, :annotationPosition=) }
+  it { should have_alias(:position, :annotation_position)             }
+
+  it { should have_alias(:annotationGuid=, :guid=) }
 
   describe '#initialize' do
     it 'raises error if document is not specified' do
@@ -236,8 +224,7 @@ describe GroupDocs::Document::Annotation do
     end
 
     it 'is aliased to #collaborators=' do
-      subject.should respond_to(:collaborators=)
-      subject.method(:collaborators=).should == subject.method(:collaborators_set!)
+      subject.should have_alias(:collaborators=, :collaborators_set!)
     end
   end
 
@@ -277,4 +264,21 @@ describe GroupDocs::Document::Annotation do
       end.should change(subject, :annotation_position).to(x: 10, y: 10)
     end
   end
+
+  describe '#set_access!' do
+    before(:each) do
+      mock_api_server(load_json('annotation_access_set'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.set_access!(:private, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'updates annotation access mode' do
+      subject.set_access!(:private)
+      subject.access.should == :private
+    end
+  end
 end

data/spec/groupdocs/document/field_spec.rb

@@ -13,10 +13,7 @@ describe GroupDocs::Document::Field do
   it { should respond_to(:rectangle)   }
   it { should respond_to(:rectangle=)  }
 
-  it 'is compatible with response JSON' do
-    subject.should respond_to(:rect=)
-    subject.method(:rect=).should == subject.method(:rectangle=)
-  end
+  it { should have_alias(:rect=, :rectangle=) }
 
   describe '#rectangle=' do
     it 'converts passed hash to GroupDocs::Document::Rectangle object' do