google-directory 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae80e614af5bed3fee0dfdc688da21f4758732c0
-  data.tar.gz: c9e47a038f68047d0405635fda1271fccb0ba246
+  metadata.gz: 80b661f11277fc8460c4e7c2397ecb5f88693bf9
+  data.tar.gz: 225a3ddcd0aefb129923c95b24297164bd449729
 SHA512:
-  metadata.gz: b7eff4e53da4d5ad2288ea779397838bd946b1cbb32978293c560cc207884ed99fe9743b5fae79226e2e495e4c37877256af0e5a89f12787f41ccab9d0799589
-  data.tar.gz: f6919051596fb55a8289fbea37097b18f8894dfa87c397c7d8d8e5ed6605d72d92b18b962a87daf8d6bdbf4530b4cb2790ff3a8b8145efe03cf6b1b98f6be2c4
+  metadata.gz: f8a06cce05e7ea09eb87f3220d1adf3e0c3f0df9bd4e50f03fdd2f2c35fc876603894cead23f1d39e184b0618a5ae168eece2954d960db8610453366cfd5ab63
+  data.tar.gz: 0550b57fd0e411351c199d7b5292b49e222a1c5654b93cda61a1987635753d54362f804a50600fc8f2150f6e23e168283704b3029e789ef8b7839cd0ec8b8bb0

data/README.md

@@ -3,7 +3,17 @@
 ## Description
 
 Simple Google Directory API wrapper for Ruby on Rails. 
-This relies on the [Google API Ruby Client](https://github.com/Omac/google-directory.git).
+This relies on the [Google API Ruby Client](https://github.com/google/google-api-ruby-client).
+
+**This library is in alpha. Future incompatible changes may be necessary.**
+
+## Requirements 
+
+* An active project in the Google Developers Console.
+* A service-to-service Client ID. [How to](https://developers.google.com/console/help/new/#serviceaccounts).
+* A valid P12 key.
+* The Admin SDK enabled.
+* Authorization from the Google Apps Admin Console to the Client ID to access the scope `https://www.googleapis.com/auth/admin.directory.user`.
 
 ## Install
 
@@ -15,22 +25,22 @@ gem 'google-directory'
 
 ## Configuration
 
-First configure your API in `initializers/google_directory.rb`
+First configure your API in `config/initializers/google_directory.rb`
 
 ``` ruby
 GoogleDirectory.configure do
 	
-	# Optional Token Store
+	# OPTIONAL. Use a YAML file to store the requested access tokens. When the token is refreshed, this file will be updated.
 	use_yaml Rails.root.join('config', 'google_directory.yaml')
 
-	# Required 
-	admin_email 'admin@domain.com'
-	key_file Rails.root.join('config', 'keys', 'private_key.p12')
-	key_passphrase 'notasecret'
-	issuer 'xxxxxxx@developer.gserviceaccount.com'
+	# Required attributes
+	admin_email      'admin@domain.com'
+	key_file         Rails.root.join('config', 'keys', 'private_key.p12')
+	key_passphrase   'notasecret'
+	issuer           'xxxxxxx@developer.gserviceaccount.com'
 
 	# Optional attributes
-	application_name 'My Application'
+	application_name    'My Application'
 	application_version '1.0.0'
 
 end
@@ -47,14 +57,12 @@ development:
     expires_in: 3600
 ```
 
-### Multiple Google API access tokens using scopes
+### Multiple API clients using scopes
 
-Specify a scope in the configuration `initializers/google_directory.rb`. 
+Specify a scope in the configuration `config/initializers/google_directory.rb`. 
 
 ``` ruby
 GoogleDirectory.configure do
-	
-	use_yaml Rails.root.join('config', 'google_directory.yaml')
 
 	scope :domain_one do
 		admin_email 'admin@domain_one.com'
@@ -68,21 +76,21 @@ GoogleDirectory.configure do
 
 end
 ```
-Keep in mind that the Token Store will be the same for all the scopes configured.
 
 ## Usage
+
 ``` ruby
 google = GoogleDirectory::Client.new
 
 google.find_users
 
-google.create_user(email, "given_name", "family_name", "password")
+google.create_user("email", "given_name", "family_name", "password")
 
-google.update_user(email, update_data)
+google.update_user("email", update_data)
 
-google.delete_user(email)
+google.delete_user("email")
 
-google.update_user_password(email, new_password)
+google.update_user_password("email", "new_password")
 
 ```
 
@@ -100,5 +108,7 @@ domain_two.find_users
 
 * `use_active_model` for database token store.
 * Build the configuration generator.
-* Implement more parameters from the Google API.
+* Implement more parameters and calls to the Admin SDK.
+* Better error handling.
+* Documentation.
 * Testing.

data/google-directory.gemspec

@@ -7,19 +7,18 @@ require "google-directory/version"
 Gem::Specification.new do |s|
 	s.name        = "google-directory"
 	s.version     = GoogleDirectory::VERSION
+	
 	s.authors     = ["Omar Osorio"]
 	s.email       = ["omar@kioru.com"]
-	s.homepage    = "https://github.com/Omac/google-directory"
+	s.homepage    = "https://github.com/kioru/google-directory"
+
 	s.summary     = "Simple Google Directory API client wrapper for Rails"
-	s.description = "Relying on the Google Ruby API gem you are able to set up a Rails project for consuming the Directory API (or the Admin SDK). Even multiple domain access is allowed using scopes."
+	s.description = "Relying on the Google Ruby API gem you are able to set up a Rails project for consuming the Directory API (or the Admin SDK). Even multiple domain access is possible using scopes."
 	s.license     = "MIT"
 
-	s.files         = `git ls-files`.split("\n") # Dir["{app,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc"]
+	s.files         = `git ls-files -z`.split("\x0")
 	s.test_files    = Dir["test/**/*"]
 	s.require_paths = ['lib']
 
 	s.add_dependency 'google-api-client', '~> 0.8'
-
-	s.add_development_dependency 'rails', '~> 4.2'
-	s.add_development_dependency "sqlite3"
 end

data/lib/google-directory.rb

@@ -4,109 +4,98 @@ require 'google/api_client'
 
 module GoogleDirectory
 
-    class Client
-
-        attr_reader :directory_api, :client, :config
-
-        def initialize(scope = :main)
-            @config = GoogleDirectory.configuration
-            @config = @config.using(scope) if @config.scope_name != scope
-
-            
-            @key = Google::APIClient::KeyUtils.load_from_pkcs12(@config.key_file, @config.key_passphrase)
-            @client = Google::APIClient.new(:application_name => @config.application_name, :application_version => @config.application_version )
-
-            @client.authorization = Signet::OAuth2::Client.new(
-                :token_credential_uri => 'https://accounts.google.com/o/oauth2/token',
-                :audience => 'https://accounts.google.com/o/oauth2/token',
-                :scope => 'https://www.googleapis.com/auth/admin.directory.user',
-                :issuer => @config.issuer, 
-                :person => @config.admin_email,
-                :signing_key => @key
-            )
-
-            if token = @config.load_token
-
-                token['issued_at'] = Time.parse( token['issued_at'] )
-                @client.authorization.update_token!(token)
-
-            else
-                token = @client.authorization.fetch_access_token!
-                token['issued_at'] = @client.authorization.issued_at.to_s
-                @config.save_token(token)
-
-            end
-            
-            @directory_api = @client.discovered_api('admin', 'directory_v1')
-        end
-
-
-        #
-        # https://developers.google.com/admin-sdk/directory/v1/reference/users/list#auth
-        # 
-        # Optional Parameters:
-        #   customFieldMask
-        #   customer
-        #   domain
-        #   maxResults
-        #   orderBy
-        #   pageToken
-        #   projection
-        #   query
-        #   showDeleted
-        #   sortOrder
-        #   viewType
-        #
-        def find_users(params)
-            execute(:api_method => directory_api.users.list, :parameters => params)
-        end
-
-        def find_user_by_email(email)
-            execute(:api_method => directory_api.users.get, :parameters => { 'userKey' => email })
-        end
-
-        #
-        # https://developers.google.com/admin-sdk/directory/v1/reference/users/insert
-        #
-        def create_user(email, given_name, family_name, password, opts = {})
-            opts = {
-                'name'                       => { 'givenName' => given_name, 'familyName' => family_name},
-                'password'                   => password,
-                'primaryEmail'               => email,
-                'changePasswordAtNextLogin'  => true
-            }.merge(opts)
-
-            execute(:api_method => directory_api.users.insert, :body_object => opts)
-        end
-
-        def delete_user(email)
-            execute(:api_method => directory_api.users.delete, :parameters => {'userKey' => email})
-        end
-
-        def update_user(email, update_data = {})
-            execute(:api_method => directory_api.users.update, :parameters => {'userKey' => email}, :body_object => update_data)
-        end
-
-        def update_user_password(email, password)
-            update_user(email, {'password' => password, 'changePasswordAtNextLogin' => false})
-        end
-
-        private 
-
-            def execute(opts)
-                if client.authorization.expired?
-                    token = client.authorization.refresh!
-                    token['issued_at'] = client.authorization.issued_at.to_s
-                    config.save_token(token)
-                end
-
-                result = client.execute(opts)
-                return JSON.parse(result.body) if result.status == 200
-                return nil if [204, 404].include?(result.status)
-
-                Rails.logger.error("== Google ERROR ==\n\t- execute(#{opts})\n\t- response:\n#{result.response.to_yaml}")
-
-            end
-    end
+	class Client
+
+		attr_reader :directory_api, :client, :config, :result
+
+		def initialize(scope = :main)
+			@config = GoogleDirectory.configuration
+			@config = @config.using(scope) if @config.scope_name != scope
+
+			
+			@key = Google::APIClient::KeyUtils.load_from_pkcs12(@config.key_file, @config.key_passphrase)
+			@client = Google::APIClient.new(:application_name => @config.application_name, :application_version => @config.application_version )
+
+			@client.authorization = Signet::OAuth2::Client.new(
+				:token_credential_uri => 'https://accounts.google.com/o/oauth2/token',
+				:audience => 'https://accounts.google.com/o/oauth2/token',
+				:scope => 'https://www.googleapis.com/auth/admin.directory.user',
+				:issuer => @config.issuer, 
+				:person => @config.admin_email,
+				:signing_key => @key
+			)
+
+			if token = @config.load_token
+
+				token['issued_at'] = Time.parse( token['issued_at'] )
+				@client.authorization.update_token!(token)
+
+			else
+				token = @client.authorization.fetch_access_token!
+				token['issued_at'] = @client.authorization.issued_at.to_s
+				@config.save_token(token)
+
+			end
+			
+			@directory_api = @client.discovered_api('admin', 'directory_v1')
+		end
+
+
+		def find_users(params)
+			execute(:api_method => directory_api.users.list, :parameters => params)
+		end
+
+		def find_user_by_email(email)
+			execute(:api_method => directory_api.users.get, :parameters => { 'userKey' => email })
+		end
+
+		#
+		# https://developers.google.com/admin-sdk/directory/v1/reference/users/insert
+		#
+		def create_user(email, given_name, family_name, password, opts = {})
+			opts = {
+				'name'                       => { 'givenName' => given_name, 'familyName' => family_name},
+				'password'                   => password,
+				'primaryEmail'               => email,
+				'changePasswordAtNextLogin'  => true
+			}.merge(opts)
+
+			execute(:api_method => directory_api.users.insert, :body_object => opts)
+		end
+
+		def delete_user(email)
+			execute(:api_method => directory_api.users.delete, :parameters => {'userKey' => email})
+		end
+
+		def update_user(email, update_data = {})
+			execute(:api_method => directory_api.users.update, :parameters => {'userKey' => email}, :body_object => update_data)
+		end
+
+		def update_user_password(email, password)
+			update_user(email, {'password' => password, 'changePasswordAtNextLogin' => false})
+		end
+
+		private 
+
+			def execute(opts)
+				if client.authorization.expired?
+					token = client.authorization.refresh!
+					token['issued_at'] = client.authorization.issued_at.to_s
+					config.save_token(token)
+				end
+
+				@result = client.execute(opts)
+				
+				case result.status
+				when 204 then return true
+				when 404 then return false
+				when 200 then return JSON.parse(result.body)
+				end
+
+				Rails.logger.error("== Google ERROR ==\n\t- execute(#{opts})\n\t- response:\n#{result.response.to_yaml}")
+
+				false
+			end
+	end
 
 end

data/lib/google-directory/version.rb

@@ -1,3 +1,3 @@
 module GoogleDirectory
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-directory
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Omar Osorio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-api-client
@@ -24,37 +24,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Relying on the Google Ruby API gem you are able to set up a Rails project
   for consuming the Directory API (or the Admin SDK). Even multiple domain access
-  is allowed using scopes.
+  is possible using scopes.
 email:
 - omar@kioru.com
 executables: []
@@ -114,7 +86,7 @@ files:
 - test/dummy/public/favicon.ico
 - test/google-directory_test.rb
 - test/test_helper.rb
-homepage: https://github.com/Omac/google-directory
+homepage: https://github.com/kioru/google-directory
 licenses:
 - MIT
 metadata: {}