groupdocs 1.5.1 → 1.5.2

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v1.5.2
+
+**Changes**
+
+* Do not replace `{{client_id}}` if `:sign` is `false`.
+
 ## v1.5.1
 
 **New**

data/examples/api-samples/Gemfile

@@ -1,5 +1,5 @@
-source :rubygems
+source 'https://rubygems.org'
 
-gem 'sinatra'
+gem 'sinatra', '1.3.6'
 gem 'groupdocs', "1.2.10"
 gem 'haml'

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

@@ -30,15 +30,6 @@ module GroupDocs
           options[:path].gsub!(%r(//+), '/')
         end
 
-        #
-        # Parses path replacing {{client_id}} with real one.
-        #
-        # @api private
-        #
-        def parse_path
-          options[:path].sub!(/\{\{client_id\}\}/, client_id)
-        end
-
         #
         # URL encodes path.
         #
@@ -52,6 +43,15 @@ module GroupDocs
           options[:path].gsub!('+', '%2B')
         end
 
+        #
+        # Parses path replacing {{client_id}} with real one.
+        #
+        # @api private
+        #
+        def replace_client_id
+          options[:path].sub!(/\{\{client_id\}\}/, client_id)
+        end
+
         #
         # Adds signature to path.
         #

data/lib/groupdocs/api/request.rb

@@ -55,9 +55,11 @@ module GroupDocs
       #
       def prepare_and_sign_url
         unless @signed
-          parse_path
           url_encode_path
-          sign_url if @options[:sign]
+          if @options[:sign]
+            replace_client_id
+            sign_url
+          end
           @signed = true
         end
 

data/lib/groupdocs/storage/file.rb

@@ -22,11 +22,15 @@ module GroupDocs
       # @example Upload file with description
       #   GroupDocs::Storage::File.upload!('resume.pdf', description: 'Resume')
       #
+      # @example Upload file with callback URL
+      #   GroupDocs::Storage::File.upload!('resume.pdf', callbackUrl: 'http://google.com')
+      #
       # @param [String] filepath Path to file to be uploaded
       # @param [Hash] options
       # @option options [String] path Folder path to upload to
       # @option options [String] name Name of file to be renamed
       # @option options [String] description File description
+      # @option options [String] callbackUrl will be called after file is uploaded
       # @param [Hash] access Access credentials
       # @option access [String] :client_id
       # @option access [String] :private_key

data/lib/groupdocs/user.rb

@@ -60,10 +60,39 @@ module GroupDocs
     end
 
     #
-    # Generates new active user embed key.
+    # Delete account user.
     #
     # @example
-    #   GroupDocs::User.embed_key!('test-area')
+    #   user = GroupDocs::User.get!
+    #   GroupDocs::User.delete!(user.users!.last)
+    #   #=> "826e3b54e009ce51"
+    #
+    # @param [GroupDocs::User] user
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [String]
+    #
+    # @raise [ArgumentError] if user is not GroupDocs::User object
+    #
+    def self.delete!(user, access = {})
+      user.is_a?(GroupDocs::User) or raise ArgumentError,
+        "User should be GroupDocs::User object, received: #{user.inspect}"
+
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/mgmt/{{client_id}}/account/users/#{user.primary_email}"
+      end.execute!
+
+      json[:guid]
+    end
+
+    #
+    # Generates new user embed key.
+    #
+    # @example
+    #   GroupDocs::User.generate_embed_key!('test-area')
     #   #=> "60a06ef8f23a49cf807977f1444fbdd8"
     #
     # @param [String] area
@@ -72,7 +101,7 @@ module GroupDocs
     # @option access [String] :private_key
     # @return [String]
     #
-    def self.embed_key!(area, access = {})
+    def self.generate_embed_key!(area, access = {})
       json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
@@ -82,6 +111,52 @@ module GroupDocs
       json[:key][:guid]
     end
 
+    #
+    # Get user embed key. Generate new embed key if area not exists.
+    #
+    # @example
+    #   GroupDocs::User.get_embed_key!('test-area')
+    #   #=> "60a06ef8f23a49cf807977f1444fbdd8"
+    #
+    # @param [String] area
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [String]
+    #
+    def self.get_embed_key!(area, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/mgmt/{{client_id}}/embedkey/#{area}"
+      end.execute!
+
+      json[:key][:guid]
+    end
+
+    #
+    # Get area name by embed key.
+    #
+    # @example
+    #   GroupDocs::User.area!('60a06eg8f23a49cf807977f1444fbdd8')
+    #   #=> "test-area"
+    #
+    # @param [String] embed_key
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [String]
+    #
+    def self.area!(embed_key, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/mgmt/{{client_id}}/embedkey/guid/#{embed_key}"
+      end.execute!
+
+      json[:key][:area]
+    end
+
     #
     # Returns an array of storage providers.
     #
@@ -107,6 +182,27 @@ module GroupDocs
       end
     end
 
+    #
+    # Logins user using user name and password.
+    #
+    # @example
+    #   user = GroupDocs::User.login!('doe@john.com', 'password')
+    #   user.first_name
+    #   #=> "John"
+    #
+    # @return [GroupDocs::User]
+    #
+    def self.login!(email, password)
+      json = Api::Request.new do |request|
+        request[:sign] = false
+        request[:method] = :POST
+        request[:path] = "/shared/users/#{email}/logins"
+        request[:request_body] = password
+      end.execute!
+
+      new(json[:user])
+    end
+
     # @attr [Integer] id
     attr_accessor :id
     # @attr [String] guid

data/lib/groupdocs/version.rb

@@ -1,3 +1,3 @@
 module GroupDocs
-  VERSION = '1.5.1'
+  VERSION = '1.5.2'
 end # GroupDocs

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

@@ -34,11 +34,11 @@ describe GroupDocs::Api::Helpers::URL do
     end
   end
 
-  describe '#parse_path' do
+  describe '#replace_client_id' do
     it 'replaces {{client_id}} with real client ID' do
       subject.options[:path] = '/doc/{{client_id}}/files/123'
       subject.should_receive(:client_id).and_return('real_client_id')
-      subject.send(:parse_path)
+      subject.send(:replace_client_id)
       subject.options[:path].should == '/doc/real_client_id/files/123'
     end
   end

data/spec/groupdocs/api/request_spec.rb

@@ -38,13 +38,19 @@ describe GroupDocs::Api::Request do
   end
 
   describe '#prepare_and_sign_url' do
-    it 'parses path' do
-      subject.should_receive(:parse_path)
+    it 'URL encodes path' do
+      subject.should_receive(:url_encode_path)
       subject.prepare_and_sign_url
     end
 
-    it 'URL encodes path' do
-      subject.should_receive(:url_encode_path)
+    it 'replaces client identifier path' do
+      subject.should_receive(:replace_client_id)
+      subject.prepare_and_sign_url
+    end
+
+    it 'does not replace client identifier path' do
+      subject.options[:sign] = false
+      subject.should_not_receive(:replace_client_id)
       subject.prepare_and_sign_url
     end
 

data/spec/groupdocs/user_spec.rb

@@ -42,20 +42,73 @@ describe GroupDocs::User do
     end
   end
 
-  describe '.embed_key!' do
+  describe '.delete!' do
+    before(:each) do
+      mock_api_server(load_json('delete_account'))
+    end
+
+    let!(:user) { GroupDocs::User.new }
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.delete!(user, :client_id => 'client_id', :private_key => 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'raises error if user is not an instance of GroupDocs::User' do
+      lambda { described_class.delete!('user') }.should raise_error(ArgumentError)
+    end
+
+    it 'returns user guid' do
+      described_class.delete!(user).should be_a(String)
+    end
+  end
+
+  describe '.generate_embed_key!' do
     before(:each) do
       mock_api_server(load_json('user_embed_key'))
     end
 
     it 'accepts access credentials hash' do
       lambda do
-        described_class.embed_key!('test-area', :client_id => 'client_id', :private_key => 'private_key')
+        described_class.generate_embed_key!('test-area', :client_id => 'client_id', :private_key => 'private_key')
       end.should_not raise_error(ArgumentError)
     end
-    
+
     it 'returns new user embed key for defined area' do
-      result = described_class.embed_key!('test-area')
-      result.should be_a(String)
+      described_class.generate_embed_key!('test-area').should be_a(String)
+    end
+  end
+
+  describe '.get_embed_key!' do
+    before(:each) do
+      mock_api_server(load_json('user_get_embed_key'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.get_embed_key!('test-area', :client_id => 'client_id', :private_key => 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns user embed key for defined area' do
+      described_class.get_embed_key!('test-area').should be_a(String)
+    end
+  end
+
+  describe '.area!' do
+    before(:each) do
+      mock_api_server(load_json('user_area'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.area!('60a06eg8f23a49cf807977f1444fbdd8', :client_id => 'client_id', :private_key => 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns area name by defined embed key' do
+      described_class.area!('60a06eg8f23a49cf807977f1444fbdd8').should be_a(String)
     end
   end
 
@@ -78,6 +131,23 @@ describe GroupDocs::User do
       end
     end
   end
+
+  describe '.login!' do
+    before(:each) do
+      mock_api_server(load_json('user_login'))
+    end
+
+    it 'works without access credentials hash' do
+      lambda do
+        described_class.login!('doe@john.com', 'password')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns GroupDocs::User object' do
+      described_class.login!('doe@john.com', 'password').should be_a(GroupDocs::User)
+    end
+  end
+
   it { should have_accessor(:id)                 }
   it { should have_accessor(:guid)               }
   it { should have_accessor(:nickname)           }

data/spec/support/json/delete_account.json

@@ -0,0 +1,10 @@
+{
+  "result": {
+    "id": 525,
+    "guid": "822e3b54e009cd52",
+    "primary_email": "test_email@email.com"
+  },
+  "status": "Ok",
+  "error_message": null,
+  "composedOn": 1367123016312
+}

data/spec/support/json/user_area.json

@@ -0,0 +1,68 @@
+{
+  "result": {
+    "key": {
+      "user": {
+        "nickname": "doe@john.com",
+        "firstname": "john",
+        "lastname": "doe",
+        "pkey": null,
+        "pswd_salt": "4b4Na2L2YQFWainXVfKOow==",
+        "claimed_id": null,
+        "token": "2639d85445430c3d05dc2c085356b9ab59bb156adda0f377be1d092b9402689b",
+        "storage": null,
+        "photo": null,
+        "active": false,
+        "trial": null,
+        "news_eanbled": false,
+        "alerts_eanbled": null,
+        "support_eanbled": null,
+        "support_email": null,
+        "annotation_branded": null,
+        "viewer_branded": null,
+        "is_real_time_broadcast_enabled": null,
+        "is_scroll_broadcast_enabled": null,
+        "is_zoom_broadcast_enabled": null,
+        "annotation_logo": null,
+        "pointer_tool_cursor": null,
+        "annotation_header_options": null,
+        "is_annotation_navigation_widget_enabled": null,
+        "is_annotation_zoom_widget_enabled": null,
+        "is_annotation_download_widget_enabled": null,
+        "is_annotation_print_widget_enabled": null,
+        "is_annotation_help_widget_enabled": null,
+        "is_right_panel_enabled": null,
+        "is_thumbnails_panel_enabled": null,
+        "is_standard_header_always_shown": null,
+        "is_toolbar_enabled": null,
+        "is_text_annotation_button_enabled": null,
+        "is_rectangle_annotation_button_enabled": null,
+        "is_point_annotation_button_enabled": null,
+        "is_strikeout_annotation_button_enabled": null,
+        "is_polyline_annotation_button_enabled": null,
+        "is_typewriter_annotation_button_enabled": null,
+        "is_watermark_annotation_button_enabled": null,
+        "viewer_logo": null,
+        "viewer_options": null,
+        "is_viewer_navigation_widget_enabled": null,
+        "is_viewer_zoom_widget_enabled": null,
+        "is_viewer_download_widget_enabled": null,
+        "is_viewer_print_widget_enabled": null,
+        "is_viewer_help_widget_enabled": null,
+        "signedupOn": 1352386502480,
+        "signedinOn": 1367051509957,
+        "signin_count": 740,
+        "roles": null,
+        "id": 3320,
+        "guid": "b912b34d1621a895",
+        "primary_email": "doe@john.com"
+      },
+      "guid": "5c4f5ac825cc618994e556d4a252b108",
+      "area": "test-area",
+      "active": true,
+      "hit_count": 2
+    }
+  },
+  "status": "Ok",
+  "error_message": null,
+  "composedOn": 1367054382377
+}

data/spec/support/json/user_get_embed_key.json

@@ -0,0 +1,68 @@
+{
+  "result": {
+    "key": {
+      "user": {
+        "nickname": "doe@john.com",
+        "firstname": "john",
+        "lastname": "doe",
+        "pkey": null,
+        "pswd_salt": "4b4Na2L2YQFWainXVfKOow==",
+        "claimed_id": null,
+        "token": "2639d8544d430c3d05dc2c085556b9ab59bb156adda0f377be1d092b9402689b",
+        "storage": null,
+        "photo": null,
+        "active": false,
+        "trial": null,
+        "news_eanbled": false,
+        "alerts_eanbled": null,
+        "support_eanbled": null,
+        "support_email": null,
+        "annotation_branded": null,
+        "viewer_branded": null,
+        "is_real_time_broadcast_enabled": null,
+        "is_scroll_broadcast_enabled": null,
+        "is_zoom_broadcast_enabled": null,
+        "annotation_logo": null,
+        "pointer_tool_cursor": null,
+        "annotation_header_options": null,
+        "is_annotation_navigation_widget_enabled": null,
+        "is_annotation_zoom_widget_enabled": null,
+        "is_annotation_download_widget_enabled": null,
+        "is_annotation_print_widget_enabled": null,
+        "is_annotation_help_widget_enabled": null,
+        "is_right_panel_enabled": null,
+        "is_thumbnails_panel_enabled": null,
+        "is_standard_header_always_shown": null,
+        "is_toolbar_enabled": null,
+        "is_text_annotation_button_enabled": null,
+        "is_rectangle_annotation_button_enabled": null,
+        "is_point_annotation_button_enabled": null,
+        "is_strikeout_annotation_button_enabled": null,
+        "is_polyline_annotation_button_enabled": null,
+        "is_typewriter_annotation_button_enabled": null,
+        "is_watermark_annotation_button_enabled": null,
+        "viewer_logo": null,
+        "viewer_options": null,
+        "is_viewer_navigation_widget_enabled": null,
+        "is_viewer_zoom_widget_enabled": null,
+        "is_viewer_download_widget_enabled": null,
+        "is_viewer_print_widget_enabled": null,
+        "is_viewer_help_widget_enabled": null,
+        "signedupOn": 1352386502480,
+        "signedinOn": 1367051509957,
+        "signin_count": 740,
+        "roles": null,
+        "id": 3320,
+        "guid": "b912b34d1621a895",
+        "primary_email": "doe@john.com"
+      },
+      "guid": "5c3f5ac825cc418994e546d4e252b108",
+      "area": "test-area",
+      "active": true,
+      "hit_count": 2
+    }
+  },
+  "status": "Ok",
+  "error_message": null,
+  "composedOn": 1367064373330
+}

data/spec/support/json/user_login.json

@@ -0,0 +1,68 @@
+{
+  "result": {
+    "user": {
+      "nickname": "doe@john.com",
+      "firstname": "John",
+      "lastname": "Doe",
+      "pkey": "d21408c4a34422e7a711f6fb727b0299",
+      "pswd_salt": "P95rsFQTh+Tw2t98L/MRIw==",
+      "claimed_id": null,
+      "token": "c28a222f08f9baf1f2718257e81a64b013544a9f66b8f63dd5625872fcfd9b14",
+      "storage": null,
+      "photo": null,
+      "active": true,
+      "trial": true,
+      "news_eanbled": false,
+      "alerts_eanbled": null,
+      "support_eanbled": null,
+      "support_email": null,
+      "annotation_branded": null,
+      "viewer_branded": null,
+      "is_real_time_broadcast_enabled": null,
+      "is_scroll_broadcast_enabled": null,
+      "is_zoom_broadcast_enabled": null,
+      "annotation_logo": null,
+      "pointer_tool_cursor": null,
+      "annotation_header_options": null,
+      "is_annotation_navigation_widget_enabled": null,
+      "is_annotation_zoom_widget_enabled": null,
+      "is_annotation_download_widget_enabled": null,
+      "is_annotation_print_widget_enabled": null,
+      "is_annotation_help_widget_enabled": null,
+      "is_right_panel_enabled": null,
+      "is_thumbnails_panel_enabled": null,
+      "is_standard_header_always_shown": null,
+      "is_toolbar_enabled": null,
+      "is_text_annotation_button_enabled": null,
+      "is_rectangle_annotation_button_enabled": null,
+      "is_point_annotation_button_enabled": null,
+      "is_strikeout_annotation_button_enabled": null,
+      "is_polyline_annotation_button_enabled": null,
+      "is_typewriter_annotation_button_enabled": null,
+      "is_watermark_annotation_button_enabled": null,
+      "is_annotation_document_name_shown": null,
+      "viewer_logo": null,
+      "viewer_options": null,
+      "is_viewer_navigation_widget_enabled": null,
+      "is_viewer_zoom_widget_enabled": null,
+      "is_viewer_download_widget_enabled": null,
+      "is_viewer_print_widget_enabled": null,
+      "is_viewer_help_widget_enabled": null,
+      "is_viewer_document_name_shown": null,
+      "signedupOn": 1355129997970,
+      "signedinOn": 1370202497952,
+      "signin_count": 15,
+      "roles": null,
+      "signature_watermark_enabled": true,
+      "signature_desktop_notifications": true,
+      "webhook_notification_retries": null,
+      "webhook_notification_failed_recipients": null,
+      "id": 4062,
+      "guid": "9c7abce33263624e",
+      "primary_email": "doe@john.com"
+    }
+  },
+  "status": "Ok",
+  "error_message": null,
+  "composedOn": 1370202497952
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groupdocs
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -417,6 +417,7 @@ files:
 - spec/support/json/datasource_get.json
 - spec/support/json/datasource_remove.json
 - spec/support/json/datasource_update.json
+- spec/support/json/delete_account.json
 - spec/support/json/document_access_info_get.json
 - spec/support/json/document_convert.json
 - spec/support/json/document_datasource.json
@@ -486,7 +487,10 @@ files:
 - spec/support/json/templates_all.json
 - spec/support/json/templates_get.json
 - spec/support/json/update_account.json
+- spec/support/json/user_area.json
 - spec/support/json/user_embed_key.json
+- spec/support/json/user_get_embed_key.json
+- spec/support/json/user_login.json
 - spec/support/json/user_profile_get.json
 - spec/support/json/user_providers.json
 - spec/support/json/user_roles.json
@@ -514,7 +518,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2320270531511539670
+      hash: -387405820343720388
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -523,7 +527,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2320270531511539670
+      hash: -387405820343720388
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -607,6 +611,7 @@ test_files:
 - spec/support/json/datasource_get.json
 - spec/support/json/datasource_remove.json
 - spec/support/json/datasource_update.json
+- spec/support/json/delete_account.json
 - spec/support/json/document_access_info_get.json
 - spec/support/json/document_convert.json
 - spec/support/json/document_datasource.json
@@ -676,7 +681,10 @@ test_files:
 - spec/support/json/templates_all.json
 - spec/support/json/templates_get.json
 - spec/support/json/update_account.json
+- spec/support/json/user_area.json
 - spec/support/json/user_embed_key.json
+- spec/support/json/user_get_embed_key.json
+- spec/support/json/user_login.json
 - spec/support/json/user_profile_get.json
 - spec/support/json/user_providers.json
 - spec/support/json/user_roles.json