angus-remote 0.0.2 → 0.0.3

data/lib/angus-remote.rb

@@ -1,4 +1,5 @@
 require 'angus/remote/client'
 require 'angus/remote/builder'
 require 'angus/remote/service_directory'
-require 'angus/remote/response/serializer'
+require 'angus/remote/response/serializer'
+require 'angus/remote/settings'

data/lib/angus/authentication/client.rb

@@ -0,0 +1,72 @@
+require 'digest'
+
+require_relative 'redis_client'
+
+module Angus
+  module Authentication
+    class Client
+
+      DEFAULT_PUBLIC_KEY = '1234567'
+      DEFAULT_PRIVATE_KEY = 'CHANGE ME!!'
+
+      AUTHENTICATION_HEADER = 'AUTHORIZATION'
+      BAAS_AUTHENTICATION_HEADER = 'X-BAAS-AUTH'
+      BAAS_SESSION_HEADER = 'X-Baas-Session-Seed'
+      DATE_HEADER = 'DATE'
+
+      def initialize(settings)
+        @public_key = settings[:public_key] || DEFAULT_PUBLIC_KEY
+        @private_key = settings[:private_key] || DEFAULT_PRIVATE_KEY
+        @store = RedisStore.new(settings[:store] || {})
+      end
+
+      def prepare_request(request, http_method, script_name)
+        date = Date.today
+
+        auth_token = generate_auth_token(date, http_method, script_name)
+        request[DATE_HEADER] = date.httpdate
+        request[AUTHENTICATION_HEADER] = generate_auth_header(auth_token)
+
+        session_auth_token = generate_session_auth_token(date, http_method, script_name)
+        request[BAAS_AUTHENTICATION_HEADER] = generate_auth_header(session_auth_token)
+      end
+
+      def store_session_private_key(response)
+        session_key_seed = extract_session_key_seed(response)
+        return unless session_key_seed
+
+        session_key = generate_session_private(session_key_seed)
+
+        @store.store_session_key(@public_key, session_key)
+      end
+
+      private
+
+      def generate_session_auth_token(date, http_method, script_name)
+        session_private_key = @store.get_session_key(@public_key)
+        Digest::SHA1.hexdigest("#{session_private_key}\n#{auth_data(date, http_method, script_name)}")
+      end
+
+      def generate_auth_token(date, http_method, script_name)
+        Digest::SHA1.hexdigest("#@private_key\n#{auth_data(date, http_method, script_name)}")
+      end
+
+      def extract_session_key_seed(response)
+        response[BAAS_SESSION_HEADER]
+      end
+
+      def auth_data(date, http_method, script_name)
+        "#{date.httpdate}\n#{http_method}\n#{script_name}"
+      end
+
+      def generate_session_private(key_seed)
+        Digest::SHA1.hexdigest("#@private_key\n#{key_seed}")
+      end
+
+      def generate_auth_header(auth_token)
+        "#@public_key:#{auth_token}"
+      end
+
+    end
+  end
+end

data/lib/angus/authentication/redis_store.rb

@@ -0,0 +1,34 @@
+require 'redis'
+
+module Angus
+  module Authentication
+
+    class RedisStore
+
+      DEFAULT_NAMESPACE = ''
+
+      def initialize(settings)
+        @namespace = settings.delete(:namespace) || DEFAULT_NAMESPACE
+        @settings = settings
+      end
+
+      def store_session_key(key, data)
+        redis.set(add_namespace(key), data)
+      end
+
+      def get_session_key(key)
+        redis.get(add_namespace(key))
+      end
+
+      def redis
+        @redis ||= Redis.new(@settings)
+      end
+
+      def add_namespace(key)
+        "#@namespace.angus-authentication-client.#{key}"
+      end
+
+    end
+
+  end
+end

data/lib/angus/remote/builder.rb

@@ -15,10 +15,11 @@ module Angus
       # @param [String] code_name The service's name known to the service directory
       # @param [Angus::SDoc::Definitions::Service] service_definition
       # @param api_url Base service api url
+      # @param [Hash] options
       #
       # @return [Remote::Client] object that implements each method specified as operation
       #   in the service metadata
-      def self.build(code_name, service_definition, api_url)
+      def self.build(code_name, service_definition, api_url, options)
         remote_service_class = build_client_class(service_definition.name)
 
         # TODO: define how to use the namespace in the remote client.
@@ -43,7 +44,7 @@ module Angus
           end
         end
 
-        remote_service_class.new(api_url, self.default_timeout)
+        remote_service_class.new(api_url, self.default_timeout, options)
       end
 
       def self.define_operation(client_class, namespace, operation, service_code_name,
@@ -58,11 +59,13 @@ module Angus
           path_params = Angus::Remote::Builder.extract_var_arg!(args, Array) || []
           encode_as_json = Angus::Remote::Builder.extract_var_arg!(args, TrueClass) || false
 
-          request_params = Angus::Remote::Builder.apply_glossary(service_definition.glossary, request_params)
+          request_params = Angus::Remote::Builder.apply_glossary(service_definition.glossary,
+                                                                 request_params)
+
           request_params = Angus::Remote::Builder.escape_request_params(request_params)
 
-          response = make_request(operation.path, operation.method, encode_as_json, path_params,
-                                  request_params)
+          response = make_request(operation.path, operation.http_method, encode_as_json,
+                                  path_params, request_params)
 
           Angus::Remote::Response::Builder.build_from_remote_response(response,
                                                                         service_code_name,
@@ -95,8 +98,8 @@ module Angus
 
           request_params = Angus::Remote::Builder.escape_request_params(request_params)
 
-          response = make_request(operation.path, operation.method, encode_as_json, path_params,
-                                  request_params)
+          response = make_request(operation.path, operation.http_method, encode_as_json,
+                                  path_params, request_params)
 
           Angus::Remote::Response::Builder.build_from_remote_response(response,
                                                                         service_code_name,
@@ -186,10 +189,10 @@ module Angus
           end
           encoded[encoded_name] = value
         end
+
         encoded
       end
 
-
       def self.default_timeout
         @default_timeout || DEFAULT_TIMEOUT
       end
@@ -201,4 +204,4 @@ module Angus
     end
 
   end
-end
+end

data/lib/angus/remote/client.rb

@@ -5,13 +5,14 @@ require_relative 'exceptions'
 require_relative 'utils'
 
 require_relative 'response/builder'
+require_relative 'settings'
 
 module Angus
   module Remote
 
     # A client for service invocation
     class Client
-      def initialize(api_url, timeout = nil)
+      def initialize(api_url, timeout = nil, options = {})
         api_url = api_url[0..-2] if api_url[-1] == '/'
 
         @connection = PersistentHTTP.new(
@@ -26,6 +27,12 @@ module Angus
         )
 
         @api_base_path = @connection.default_path
+
+        client_settings = { :public_key => options['public_key'],
+                            :private_key => options['private_key'],
+                            :store => Settings.redis }
+
+        @authentication_client = Authentication::Client.new(client_settings)
       end
 
       # Makes a request to the service
@@ -51,8 +58,12 @@ module Angus
         request = Utils.build_request(method, path, request_params, encode_as_json)
 
         begin
+          @authentication_client.prepare_request(request, method.upcase, path)
+
           response = @connection.request(request)
 
+          @authentication_client.store_session_private_key(response)
+
           if Utils.severe_error_response?(response)
             raise RemoteSevereError.new(get_error_messages(response.body))
           end
@@ -73,6 +84,7 @@ module Angus
         json_response = JSON(response_body) rescue { 'messages' => [] }
         Response::Builder::build_messages(json_response['messages'])
       end
+
     end
 
   end

data/lib/angus/remote/exceptions.rb

@@ -11,6 +11,16 @@ module Angus
 
     end
 
+    class RemoteSevereError < Exception
+
+      attr_reader :messages
+
+      def initialize(messages)
+        @messages = messages
+      end
+
+    end
+
     class RemoteConnectionError < Exception
 
       def initialize(url)

data/lib/angus/remote/service_directory.rb

@@ -1,7 +1,9 @@
+require 'digest'
 require 'json'
 require 'yaml'
 
 require 'angus/sdoc'
+require 'angus/authentication/client'
 
 require_relative 'builder'
 require_relative 'exceptions'
@@ -17,7 +19,6 @@ module Angus
 
       # Builds and returns a Client object for the service and version received
       def self.lookup(code_name, version = nil)
-
         version ||= service_version(code_name)
 
         @clients_cache ||= {}
@@ -28,7 +29,8 @@ module Angus
         begin
           service_definition = self.service_definition(code_name, version)
           client = Angus::Remote::Builder.build(code_name, service_definition,
-                                                  self.api_url(code_name, version))
+                                                self.api_url(code_name, version),
+                                                service_settings(code_name, version))
           @clients_cache[[code_name, version]] = client
 
         rescue Errno::ECONNREFUSED
@@ -78,7 +80,7 @@ module Angus
 
         config = service_configuration(code_name)
 
-        config["v#{version}"]["api_url"]
+        config["v#{version}"]['api_url']
       end
 
       # Returns the configured version.
@@ -98,20 +100,6 @@ module Angus
         end
       end
 
-      # Returns the connection configuration for a given service.
-      #
-      # @param [String] code_name Service name
-      #
-      # @return [Hash]
-      #
-      # @raise [ServiceConfigurationNotFound] When no configuration for the given service
-      def self.service_configuration(code_name)
-        @services_configuration ||= YAML.load_file(SERVICES_CONFIGURATION_FILE)
-
-        @services_configuration[code_name] or
-          raise ServiceConfigurationNotFound.new(code_name)
-      end
-
       # Returns the service's definition for the given service name and version
       #
       # @param [String] code_name Service that acts as a proxy.
@@ -153,7 +141,7 @@ module Angus
 
         proxy_doc_url = self.proxy_doc_url(code_name, version, remote_code_name)
 
-        definition_hash = fetch_remote_service_definition(proxy_doc_url)
+        definition_hash = fetch_remote_service_definition(proxy_doc_url, code_name, version)
 
         proxy_service_definition = Angus::SDoc::DefinitionsReader.build_service_definition(definition_hash)
 
@@ -177,7 +165,7 @@ module Angus
         if doc_url.match('file://(.*)') || doc_url.match('file:///(.*)')
           Angus::SDoc::DefinitionsReader.service_definition($1)
         else
-          definition_hash = fetch_remote_service_definition(doc_url)
+          definition_hash = fetch_remote_service_definition(doc_url, code_name, version)
           Angus::SDoc::DefinitionsReader.build_service_definition(definition_hash)
         end
       end
@@ -185,10 +173,11 @@ module Angus
       # Fetches a service definition from a remote http uri.
       #
       # @param [String] uri URI that publishes a service definition.
-      #   That uri should handle JSON format.
+      # @param [String] code_name Name of the service.
+      # @param [String] version Version of the service.
       #
       # @return [Hash] Service definition hash
-      def self.fetch_remote_service_definition(uri)
+      def self.fetch_remote_service_definition(uri, code_name, version)
         uri = URI(uri)
         uri.query = URI.encode_www_form({:format => :json})
 
@@ -202,15 +191,68 @@ module Angus
         response = connection.start do |http|
           request = Net::HTTP::Get.new(uri.request_uri)
 
+          authentication_client(code_name, version).prepare_request(request, 'GET', uri.path)
+
           http.request(request)
         end
 
+        authentication_client(code_name, version).store_session_private_key(response)
+
         JSON(response.body)
       rescue Exception
         raise RemoteConnectionError.new(uri)
       end
       private_class_method :fetch_remote_service_definition
 
+      def self.authentication_client(code_name, version)
+        @authentication_clients ||= {}
+
+        unless @authentication_clients.include?([code_name, version])
+          service_settings = service_settings(code_name, version)
+
+          settings = { :public_key => service_settings['public_key'],
+                       :private_key => service_settings['private_key'],
+                       :store => Settings.redis.merge({ :namespace => "#{code_name}.#{version}" }) }
+
+          @authentication_clients[[code_name, version]] = Angus::Authentication::Client.new(settings)
+        end
+
+        @authentication_clients[[code_name, version]]
+      end
+      private_class_method :authentication_client
+
+      # Returns the documentation url from the configuration file
+      #
+      # @param [String] code_name Name of the service.
+      # @param [String] version Version of the service.
+      #
+      # If no version given, it reads the version from the configuration file.
+      #
+      # @raise (see .service_version)
+      def self.service_settings(code_name, version = nil)
+        version ||= service_version(code_name)
+
+        config = service_configuration(code_name)
+
+        config["v#{version}"]
+      end
+      private_class_method :service_settings
+
+      # Returns the connection configuration for a given service.
+      #
+      # @param [String] code_name Service name
+      #
+      # @return [Hash]
+      #
+      # @raise [ServiceConfigurationNotFound] When no configuration for the given service
+      def self.service_configuration(code_name)
+        @services_configuration ||= YAML.load_file(SERVICES_CONFIGURATION_FILE)
+
+        @services_configuration[code_name] or
+          raise ServiceConfigurationNotFound.new(code_name)
+      end
+      private_class_method :service_configuration
+
     end
 
   end

data/lib/angus/remote/settings.rb

@@ -0,0 +1,29 @@
+require 'uri'
+
+require_relative 'client'
+require_relative 'response/builder'
+
+module Angus
+  module Remote
+
+    module Settings
+
+      def self.add_option(name, default_value)
+        define_singleton_method(name) do
+          instance_variable_get("@#{name}") || default_value
+        end
+
+        define_singleton_method("#{name}=") do |value|
+          instance_variable_set("@#{name}", value)
+        end
+      end
+
+      DEFAULT_TIMEOUT = 60
+
+      add_option(:default_timeout, DEFAULT_TIMEOUT)
+      add_option(:redis, {})
+
+    end
+
+  end
+end

data/lib/angus/remote/version.rb

@@ -1,7 +1,7 @@
 module Angus
   module Remote
 
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
 
   end
 end

data/spec/angus/remote/builder_spec.rb

@@ -10,8 +10,8 @@ describe Angus::Remote::Builder do
   describe '.build' do
 
     let(:code_name) { 'vpos' }
-    let(:operation) { double(:operation, :code_name=> 'get_users', :service_name => 'vpos', :path => '/users', :method => :get) }
-    let(:proxy_operation) { double(:proxy_operation, :code_name=> 'get_users_proxy', :service_name => 'vpos', :path => '/users', :method => :get) }
+    let(:operation) { double(:operation, :code_name=> 'get_users', :service_name => 'vpos', :path => '/users', :http_method => :get) }
+    let(:proxy_operation) { double(:proxy_operation, :code_name=> 'get_users_proxy', :service_name => 'vpos', :path => '/users', :http_method => :get) }
     let(:glossary) { double(:glossary, :terms_hash_with_long_names => {}) }
     let(:service_definition) { double(:vpos, :name => 'Vpos', :operations => { 'users' => [operation] },
                                       :proxy_operations => { 'users' => [proxy_operation] }, :version => '0.1', :glossary => glossary) }
@@ -20,7 +20,7 @@ describe Angus::Remote::Builder do
 
     describe 'the returned class' do
 
-      subject(:client) { builder.build(code_name, service_definition, api_url) }
+      subject(:client) { builder.build(code_name, service_definition, api_url, {}) }
 
       it 'is of class Angus::Remote::Client' do
         should be_kind_of(Angus::Remote::Client)

data/spec/angus/remote/client_spec.rb

@@ -17,11 +17,33 @@ describe Angus::Remote::Client do
 
   describe '#make_request' do
 
-    it 'returns the remote service response' do
-      response = double(:response, :code => 200, :body => '[]')
-      PersistentHTTP.any_instance.stub(:request => response)
+    let(:success_response) { double(:response, :code => 200, :body => '[]') }
+    let(:authentication_client) { double(:authentication_client) }
+
+    before do
+      Angus::Authentication::Client.stub(:new => authentication_client)
+      authentication_client.stub(:prepare_request => nil, :store_session_private_key => nil)
+      PersistentHTTP.any_instance.stub(:request => success_response)
+    end
+
+    it 'prepares the request with authentication' do
+      client.make_request('/users', 'get', false, [], {})
+
+      authentication_client.should have_received(:prepare_request).with(kind_of(Net::HTTP::Get),
+                                                                        'GET', '//users')
+    end
 
-      client.make_request('/users', 'get', false, [], {}).should eq(response)
+    it 'extracts the authentication data from the response' do
+      client.make_request('/users', 'get', false, [], {})
+
+      authentication_client.should have_received(
+                                     :store_session_private_key
+                                   ).with(success_response)
+    end
+
+
+    it 'returns the remote service response' do
+      client.make_request('/users', 'get', false, [], {}).should eq(success_response)
     end
 
     context 'when an invalid method is used' do

data/spec/angus/remote/service_directory_spec.rb

@@ -52,7 +52,7 @@ describe Angus::Remote::ServiceDirectory do
 
       it 'gets the definition hash from the remote service' do
         service_directory.should_receive(:fetch_remote_service_definition).with(
-          doc_url
+          doc_url, code_name, version
         ).and_return(definition_hash)
 
         service_directory.get_service_definition(code_name, version)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: angus-remote
 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: 2013-10-31 00:00:00.000000000 Z
+date: 2013-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: angus-sdoc
@@ -60,6 +60,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: redis
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +124,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -189,6 +221,7 @@ files:
 - lib/angus/remote/http/multipart_methods/multipart_post.rb
 - lib/angus/remote/http/multipart.rb
 - lib/angus/remote/message.rb
+- lib/angus/remote/settings.rb
 - lib/angus/remote/builder.rb
 - lib/angus/remote/proxy_client_utils.rb
 - lib/angus/remote/response/builder.rb
@@ -200,6 +233,8 @@ files:
 - lib/angus/remote/client.rb
 - lib/angus/remote/proxy_client.rb
 - lib/angus/remote/utils.rb
+- lib/angus/authentication/client.rb
+- lib/angus/authentication/redis_store.rb
 - spec/angus/remote/service_directory_spec.rb
 - spec/angus/remote/proxy_client_utils_spec.rb
 - spec/angus/remote/http/query_params_spec.rb