ruby_provisioning_api 0.0.2 → 0.0.3

data/.gitignore

@@ -26,3 +26,4 @@ doc/
 .wizzy
 wizzy
 .wizzy-config
+.DS_Store

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.2
+notifications:
+  recipients:
+    - davide.targa@gmail.com
+    - damiano.braga@gmail.com

data/{README.md → README.mkd}

@@ -1,6 +1,6 @@
 # RubyProvisioningApi
 
-TODO: Write a gem description
+[Wiki](https://github.com/digitalprog/ruby_provisioning_api/wiki) | [RDocs] (http://rdoc.info/github/digitalprog/ruby_provisioning_api/frames)
 
 ## Installation
 

data/README.rdoc

@@ -0,0 +1,3 @@
+= RubyProvisioningApi
+
+Wiki[https://github.com/digitalprog/ruby_provisioning_api/wiki] | RDocs[http://rdoc.info/github/digitalprog/ruby_provisioning_api/frames]

data/lib/ruby_provisioning_api/config/google_apps.yml

@@ -1,3 +1,3 @@
-:username: brgdmn
-:password: 23428dami
-:domain: damianobraga.com
+:username: username
+:password: password
+:domain: domain

data/lib/ruby_provisioning_api/configuration.rb

@@ -2,11 +2,10 @@ module RubyProvisioningApi
 
   class Configuration
 
-    attr_accessor :config_file, :user_path, :group_path, :user_actions, :group_actions, :base_apps_url, :base_path
-    attr_reader :config
+    attr_accessor :config_file, :base_apps_url, :base_path, :http_debug, :ca_file
+    attr_reader :config, :user_path, :group_path, :user_actions, :group_actions
 
     def initialize
-      #@config_file = "{YOUR_DIRECTORY}/config/google_apps.yml"
       config_file = "#{Rails.root}/config/google_apps.yml"
 
       if File.exist?(config_file)
@@ -15,6 +14,8 @@ module RubyProvisioningApi
         raise "RubyProvisioningApi: File #{config_file} not found, maybe you forgot to define it ?"
       end
 
+      @ca_file = nil
+      @http_debug = false
       @base_apps_url = 'https://apps-apis.google.com'
       @base_path = '/a/feeds'
       @user_path = "/#{@config[:domain]}/user/2.0"

data/lib/ruby_provisioning_api/connection.rb

@@ -11,11 +11,13 @@ module RubyProvisioningApi
     end
 
     def client(url)
-      # TODO: move ca_file option into initializer
-      client = Faraday.new(:url => url, :ssl => {:ca_file => '/usr/lib/ssl/certs/ca-certificates.crt'}) do |faraday|
+      client_params = { :url => url }
+      if RubyProvisioningApi.configuration.ca_file
+        client_params[:ssl] = {:ca_file => RubyProvisioningApi.configuration.ca_file}
+      end
+      client = Faraday.new(client_params) do |faraday|
         faraday.request  :url_encoded             # form-encode POST params
-        # TODO :move log level into initializer
-        # faraday.response :logger                  # log requests to STDOUT
+        faraday.response :logger if RubyProvisioningApi.configuration.http_debug # log requests to STDOUT
         faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
       end
     end

data/lib/ruby_provisioning_api/user.rb

@@ -212,14 +212,30 @@ module RubyProvisioningApi
       save(:validate => false)
     end
 
-    #Delete user DELETE https://apps-apis.google.com/a/feeds/domain/user/2.0/userName
+    # Delete a user account
+    # @note This method executes a <b>DELETE</b> request to <i>apps-apis.google.com/a/feeds/domain/user/2.0/userName</i>
+    #
+    # @example Delete the user "foo"
+    #   user = RubyProvisioningApi::User.find("foo") # => [User]
+    #   user.delete # => true
+    #
+    # @see https://developers.google.com/google-apps/provisioning/#deleting_a_user_account
+    # @return [Boolean] true if the operation succeeded, false otherwise
+    #
     def delete
       params = self.class.prepare_params_for(:delete, "userName" => user_name)
       response = self.class.perform(params)
     end
 
     # Returns all the groups which the user is subscribed to
-    # TODO: move this inside member
+    #
+    # @example List all the groups which the user "foo" is subscribed to
+    #   user = RubyProvisioningApi::User.find("foo") # => [User]
+    #   user.groups # => [Array<Group>]
+    #
+    # @see For more info see: Group.groups
+    # @return [Array<Group>]
+    #
     def groups
       Group.groups(user_name)
     end

data/lib/ruby_provisioning_api/version.rb

@@ -1,3 +1,3 @@
 module RubyProvisioningApi
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_provisioning_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-27 00:00:00.000000000 Z
+date: 2012-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -84,11 +84,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .DS_Store
 - .gitignore
 - .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE
-- README.md
+- README.mkd
+- README.rdoc
 - Rakefile
 - lib/ruby_provisioning_api.rb
 - lib/ruby_provisioning_api/config/google_apps.yml