koinz 0.0.4 → 0.0.5

data/README

@@ -0,0 +1,54 @@
+The 'Koinz' gem is the client-library for koinz services:
+- The Koinz omniauth provider (for OAuth2 access)
+- For publishing and subscribing to Koinz notifications!
+
+# Token Authentication #
+
+As a koinz client-application, you can make 2 types of calls to other 
+applications:
+- within the context of the an end-user (Standard OAuth)
+- directly invoking a call without the end-user (2-legged)
+
+To invoke an 'token-authenticable' call with user-context
+=========================================================
+
+## Only For User Manager ##
+[param] auth_token: The auth token string
+[param] uri: The uri to be invoked on the User Manager
+
+[returns] Decoded Json information.
+
+Koinz::OAuth2Client::UserManager.call(auth_token, uri)
+
+Example:
+Koinz::OAuth2Client::UserManager.call(auth_token, '/users/sign_out.json')
+
+
+## For other applications ##
+
+[param] auth_token: The auth token string
+[param] host: The host you want to invoke this on. MERCHANT_APP, PARTNER_APP etc.
+[param] uri: The uri to be invoked on the host
+[param] params: optional arguments
+
+[returns] Decoded Json information.
+
+Koinz::OAuth2Client.Application.oauth_call(auth_token, host, uri, params => {})
+
+Example:
+Koinz::OAuth2Client.Application.oauth_call(auth_token, MERCHANT_APP, '/merchant.json', :name => 'name'
+
+To invoke a '2-legged' call without user-context
+=================================================
+
+[param] host: The host you want to invoke this on. MERCHANT_APP, PARTNER_APP etc.
+[param] uri: The uri to be invoked on the host
+[param] params: optional arguments
+
+Koinz::OAuth2Client::Application.two_legged_call(host, uri, params = {})
+
+NOTE: This call is a protected call - internally it picks up the APP, APP_ID and APP_SECRET 
+of the application and secures a oauth_token. In this particular case, if the application
+token has expired, it will be automatically refreshed!
+
+

data/lib/koinz/notification.rb

@@ -15,7 +15,7 @@ module Koinz
       # psubscribe
 
       # Process pending messages first!
-      REDIS_SUB.pending_messages(events.flatten, &block)
+      REDIS_SUB.backlog(events.flatten, &block)
 
       REDIS_SUB.psubscribe(*(events.flatten)) do |on|
         on.psubscribe do |event, total|

data/lib/koinz/omniauth_client.rb

@@ -31,8 +31,9 @@ module Koinz
       # @param [Hash] params to be passed in the URL
       # TODO: Do we need to support Http-post?
       # Example:
-      #   Koinz::OAuth2Client.Application.call(@user_session.auth_token, MERCHANT_APP, '/merchant', :name => 'name'
-      def self.call(access_token, host, uri, params = {})
+      #   Koinz::OAuth2Client.Application.oauth_call(auth_token, MERCHANT_APP, 
+      #                                             '/merchant', :name => 'name'
+      def self.oauth_call(access_token, host, uri, params = {})
         # Prepare the entire URL
         request_uri = "#{host}/#{uri}?access_token=#{access_token}"
 
@@ -42,6 +43,11 @@ module Koinz
         end
 
         response = Net::HTTP.get_response(URI.parse(request_uri))
+
+        # Raise an exception if response is not valid
+        # A redirect implies token is not valid
+        raise OAuth2::AccessDenied.new if [:found, :unauthorized].include?(response.code)
+
         result = ActiveSupport::JSON.decode(response.body)
         return result
 
@@ -49,7 +55,35 @@ module Koinz
           return { :error => e.message }
       end
 
-      def self.secure_token(strategy)
+
+      # This is a method with which any application can make a 2-legged oauth call
+      # to the other apps. Its caters to token-expiry and exceptions.
+      # In case of error, it returns Json: { :error => <err-message> }
+      def self.two_legged_call(host, uri, params = {})
+        result = {}
+        3.times do |attempts|
+          @@SECURE_TOKEN ||= secure_token
+          result = oauth_call(@@SECURE_TOKEN.token, host, uri, params)
+
+          if result.is_a?(Hash) and result[:error] && result[:error] =~ /401|302/
+            # OAuth2::AccessDenied (Received HTTP 401 during request.)
+            # Token expired -- refresh and retry
+
+            @@SECURE_TOKEN = secure_token
+          else
+            break
+          end
+        end
+        return result
+      end
+
+private
+  
+      # Note: There is a dependency on APP, APP_ID, APP_SECRET 
+      # set in the initializer of the application
+      def self.secure_token
+        Rails.logger.info("#{APP}, #{APP_ID}, #{APP_SECRET}")
+        strategy = OmniAuth::Strategies::Koinz.new(APP, APP_ID, APP_SECRET)
         client = strategy.client
 
         req_params = client.web_server.access_token_params(nil, { :redirect_uri => strategy.secure_callback_url})

data/lib/koinz/redis.rb

@@ -12,11 +12,13 @@ class KoinzRedis < Redis
     timestamp = Time.now.to_i
     zadd(channel, timestamp, MultiJson.encode([channel, message]))
     super(channel, MultiJson.encode(message))
+
+    prune(channel)
   end
 
   # returns the pending messages [ event, payload ] pairs
   # Events are ordered sets based on timstamp!
-  def pending_messages(channels, &block)
+  def backlog(channels, &block)
     return if @timestamp == 0
 
     Rails.logger.info('Processing Pending messages')
@@ -41,4 +43,15 @@ class KoinzRedis < Redis
 
     Rails.logger.info('Completed processing of pending messages')
   end
+
+  # For the sake of simplicity, speed and efficiency, we prune only events
+  # which we have just published!
+  def prune(channel)
+    # All the application timestamps. We have to pass varargs hence we send 
+    # *keys to mget! 
+    threshold = mget(*keys('*_timestamp_*')).sort.first # The earliest timestamp
+
+    # threshold is the timestamp before which all events should be destroyed
+    zremrangebyscore(channel, '-inf', threshold)
+  end
 end

data/lib/koinz/version.rb

@@ -1,3 +1,3 @@
 module Koinz
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: koinz
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Gautam Rege
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-10 00:00:00 +05:30
+date: 2011-01-14 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency