accounts_client 0.0.1

data/app/models/padma_account.rb

@@ -0,0 +1,29 @@
+# wrapper for PADMA-Accounts Account API interaction
+# Configuration for LogicalModel on /config/initializers/logical_model.rb
+class PadmaAccount < LogicalModel
+  self.hydra = Accounts::HYDRA
+  self.use_ssl = (Rails.env=="production")
+
+  self.resource_path = "/v0/accounts"
+  self.attribute_keys = [:id, :name, :enabled ]
+  self.use_api_key = true
+  self.api_key_name = "token"
+  self.api_key = Accounts::API_KEY
+  self.host  = Accounts::HOST
+
+  TIMEOUT = 5500 # milisecons
+  PER_PAGE = 9999
+
+  def enabled?
+    self.enabled
+  end
+
+  def users
+    PadmaUser.paginate :params => { :account_name => self.name }
+  end
+
+  def contacts
+    PadmaContact.paginate :params => { :account_name => self.name }
+  end
+
+end

data/app/models/padma_user.rb

@@ -0,0 +1,36 @@
+class PadmaUser < LogicalModel
+  self.hydra = Accounts::HYDRA
+  self.use_ssl = (Rails.env=="production")
+
+  self.resource_path = "/v0/users"
+  self.attribute_keys = [:username, :drc_login, :email, :locale, :accounts, :roles, :verbose_help ] # drc_login is OBSOLETE. remove.
+  self.use_api_key = true
+  self.api_key_name = "token"
+  self.api_key = Accounts::API_KEY
+  self.host  = Accounts::HOST
+
+  TIMEOUT = 5500 # milisecons
+  PER_PAGE = 9999
+
+  # LogicalModel expects an id to create resource_uri
+  def id
+    self.username
+  end
+
+  # Returns my accounts as Padma::Account objects
+  # @return [Array <PadmaAccount>]
+  def padma_accounts
+    self.accounts.map{|a|PadmaAccount.new(a)}
+  end
+
+  # Returns me enabled accounts as Padma::Account objects
+  # @return [Array <PadmaAccount>] enabled accounts
+  def enabled_accounts
+    return [] if self.accounts.nil?
+    self.accounts.reject{|a|!a['enabled']}.map{|a|PadmaAccount.new(a)}
+  end
+
+  def verbose_help?
+    !!self.verbose_help
+  end
+end

data/config/initializers/accounts_client.rb

@@ -0,0 +1,17 @@
+if(defined?(Rails))
+  module Accounts
+
+    unless defined? HYDRA
+      HYDRA = Typhoeus::Hydra.new
+    end
+
+    HOST = case Rails.env
+      when "production"
+       "padma-accounts.heroku.com"
+      when "development"
+       "localhost:3001"
+      when "test"
+       "localhost:3001"
+    end
+  end
+end

data/lib/accounts/belongs_to_account.rb

@@ -0,0 +1,52 @@
+# this module assumes base class has aa account_name attribute.
+module Accounts
+  module BelongsToAccount
+
+    def self.included(base)
+      base.send(:validate, :padma_account_setted_correctly)
+    end
+
+    attr_accessor :padma_account
+    ##
+    # Returns associated account.
+    #
+    # account is stored in instance variable padma_account. This allows for it to be setted in a Mass-Load.
+    #
+    # @param options [Hash]
+    # @option options [TrueClass] decorated          - returns decorated account
+    # @option options [TrueClass] force_service_call - forces call to accounts-ws
+    # @return [PadmaAccount / PadmaAccountDecorator]
+    def account(options={})
+      if self.padma_account.nil? || options[:force_service_call]
+        self.padma_account = PadmaAccount.find(account_name)
+      end
+      ret = padma_account
+      if options[:decorated] && padma_account
+        ret = PadmaAccountDecorator.decorate(padma_account)
+      end
+      ret
+    end
+
+    private
+
+    # If padma_account is setted with a PadmaAccount that doesn't match
+    # account_id an exception will be raised
+    # @raises 'This is the wrong account!'
+    # @raises 'This is not a account!'
+    def padma_account_setted_correctly
+      return if self.padma_account.nil?
+      unless padma_account.is_a?(PadmaAccount)
+        raise 'This is not a account!'
+      end
+      if padma_account.name != self.account_name
+        if self.account_name.nil?
+          # if they differ because account_id is nil we set it here
+          self.account_name = self.padma_account.name
+        else
+          raise 'This is the wrong account!'
+        end
+      end
+    end
+  end
+end
+

data/lib/accounts/belongs_to_user.rb

@@ -0,0 +1,54 @@
+# this module assumes base class has a username attribute.
+#
+# Including this module adds Class#user to access PadmaUser stored in memory in Class#padma_user
+module Accounts
+  module BelongsToUser
+
+    def self.included(base)
+      base.send(:validate, :padma_user_setted_correctly)
+    end
+
+    attr_accessor :padma_user
+    ##
+    # Returns associated user.
+    #
+    # user is stored in instance variable padma_user. This allows for it to be setted in a Mass-Load.
+    #
+    # @param options [Hash]
+    # @option options [TrueClass] decorated          - returns decorated user
+    # @option options [TrueClass] force_service_call - forces call to users-ws
+    # @return [PadmaUser / PadmaUserDecorator]
+    def user(options={})
+      if self.padma_user.nil? || options[:force_service_call]
+        self.padma_user = PadmaUser.find(username)
+      end
+      # TODO cache
+      ret = padma_user
+      if options[:decorated] && padma_user
+        ret = PadmaUserDecorator.decorate(padma_user)
+      end
+      ret
+    end
+
+    private
+
+    # If padma_user is setted with a PadmaUser that doesn't match
+    # Class#username an exception will be raised
+    # @raises 'This is the wrong user!'
+    # @raises 'This is not a user!'
+    def padma_user_setted_correctly
+      return if self.padma_user.nil?
+      unless padma_user.is_a?(PadmaUser)
+        raise 'This is not a user!'
+      end
+      if padma_user.username != self.username
+        if self.username.nil?
+          # if they differ because user_id is nil we set it here
+          self.username = self.padma_user.username
+        else
+          raise 'This is the wrong user!'
+        end
+      end
+    end
+  end
+end

data/lib/accounts/is_a_user.rb

@@ -0,0 +1,55 @@
+module Accounts
+  module IsAUser
+
+    def self.included(base)
+      base.send(:validate, :has_access_to_current_account)
+      base.send(:include, Accounts::BelongsToUser)
+      base.send(:include, Accounts::BelongsToAccount)
+      base.send(:delegate, :email, to: :padma_user)
+      base.send(:delegate, :verbose_help?, to: :padma_user)
+    end
+
+    def padma(cache=true)
+      self.user(force_service_call: !cache)
+    end
+
+    # Returns true if this user
+    # has enabled padma accounts
+    # @return [TrueClass]
+    def padma_enabled?
+      ea = self.enabled_accounts
+      !(ea.nil? || ea.empty?)
+    end
+
+    # Returns locale for this user retrieving it from PADMA ACCOUNTS
+    # @return [String] locale
+    def locale
+      self.padma.try :locale
+    end
+
+    # Returns enabled accounts associated with this user from PADMA ACCOUNTS
+    #
+    # @return [Array <PadmaAccount>]
+    def enabled_accounts
+      self.padma.try(:enabled_accounts)
+    end
+
+    private
+
+    # Validates that current_account_name
+    # checking that user belongs to such account
+    def has_access_to_current_account
+      return if self.current_account.nil? || !self.current_account_id_changed?
+
+      if self.enabled_accounts.nil?
+        # nil means error in connection
+        self.errors.add(:current_account_id, I18n.t('user.couldnt_connect_to_check_current_account'))
+      else
+        unless self.current_account.name.in?(self.enabled_accounts.map{|ea|ea.name})
+          self.errors.add(:current_account_id, I18n.t('user.invalid_current_account'))
+        end
+      end
+
+    end
+  end
+end

data/lib/accounts/railties.rb

@@ -0,0 +1,4 @@
+module AccountsClient
+  class Engine < Rails::Engine
+  end
+end

data/lib/accounts_client.rb

@@ -0,0 +1,7 @@
+require 'logical_model'
+if defined?(Rails)
+  require 'accounts/railties'
+  require 'accounts/is_a_user'
+  require 'accounts/belongs_to_account'
+  require 'accounts/belongs_to_user'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: accounts_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dwayne Macgowan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: logical_model
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is client library for padma-Accounts-ws
+email:
+- dwaynemac@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/padma_user.rb
+- app/models/padma_account.rb
+- lib/accounts/belongs_to_account.rb
+- lib/accounts/belongs_to_user.rb
+- lib/accounts/is_a_user.rb
+- lib/accounts/railties.rb
+- lib/accounts_client.rb
+- config/initializers/accounts_client.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Client library for padma-Accounts-ws
+test_files: []
+has_rdoc: