gridspace 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fe50bf83a2edd12b4dfc7983fa4d090aab27133
-  data.tar.gz: dbd67387e01074068bf04276a1e90cb99de99364
+  metadata.gz: 5c8b345d04ba7233afb7d08b0d52341fd38f6cda
+  data.tar.gz: 29bf156a42879e9f8c9eb89db83416f35d441f88
 SHA512:
-  metadata.gz: d645017263619c6ce36e9b16e3e574d7e72b6f8913a886dfaf524c6fc27f1bc11957e1cc707548b7a0b234ecc9a579c0188eab8519d689158068ebb5ee2663fd
-  data.tar.gz: 703a182c79ff94408bee918536e506a6179411bab2375de1f76878163360d7f325ee71ec188b089d128296ef59345a8c2608c4f7cb06fa055e97fe1bc1488f37
+  metadata.gz: 5b34799a1a5032ee2738635ec66a969133542b26977e4fd060ac3877ebb21f68db0bed591621a7fbe55fe7b48fb982be021b9f6f1389624f7afcdbdb1fd82f7c
+  data.tar.gz: 822432b4584dcd25faa60f92e573da6b894f124b65e1662e3518af08f7b22b13c054b2bc4f5003ebff513c1f560ba3c3860818f5b93c398323c3ca20513845ea

data/lib/gridspace/capability.rb

@@ -1,7 +1,7 @@
 require 'jwt'
 
 module Gridspace
-  module Util
+  module Sift
     def url_encode(hash)
       hash.to_a.map {|p| p.map {|e| CGI.escape get_string(e)}.join '='}.join '&'
     end
@@ -15,31 +15,49 @@ module Gridspace
     end
 
     class Capability
-      include Gridspace::Util
+      include Gridspace::Sift
 
-      def initialize(account_sid, auth_token)
-        @account_sid = account_sid
+      # A token to control permissions with Gridspace relying-party client
+      # *Args* :
+      #   - +account_id+ -> The account id to which this token is granted access
+      #   - +auth_token+ -> The secret key used to sign the token. Note, this auth token is not visible to the
+      #                 user of the token.
+      # *Returns*:
+      #   - A new ``GridspaceCapability`` with zero permissions
+      def initialize(account_id, auth_token)
+        @account_id = account_id
         @auth_token = auth_token
-        if @account_sid.nil? || @auth_token.nil?
-          raise ArgumentError, 'Account SID and auth token are required'
+        if @account_id.nil? || @auth_token.nil?
+          raise ArgumentError, 'Account ID and auth token are required'
         end
         @capabilities = []
       end
 
+      # Allow the user of this token to accept incoming connections at the given client name.
+      # This function grants the ``GridspaceCapability`` the permission to allow incoming connections
+      # *Args*:
+      #   - +client_name+ -> Client name to accept calls from. This should be unique among all clients 
+      #                      using capability tokens generated from a given API account
       def allow_client_incoming(client_name)
         @client_name = client_name # stash for use in outgoing
         scope_params = { 'clientName' => client_name }
         @capabilities << scope_uri_for('client', 'incoming', scope_params)
       end
 
-      def allow_client_outgoing(app_sid, params = {})
+      # Allow the user of this token to make outgoing connections. Keyword arguments are passed to 
+      # the application. This function grants the ``GridspaceCapability`` the permission to allow 
+      # outgoing connections
+      # *Args*:
+      #   - +applicaiton_id+ -> `Application` to contact
+      def allow_client_outgoing(app_id, params = {})
         @allow_client_outgoing = true
-        @outgoing_scope_params = { 'appSid' => app_sid }
+        @outgoing_scope_params = { 'appId' => app_id }
         unless params.empty?
           @outgoing_scope_params['appParams'] = url_encode params
         end
       end
 
+      # Allow the user of this token to access their event stream
       def allow_event_stream(filters = {})
         scope_params = { 'path' => '/2010-04-01/Events' }
         scope_params['params'] = filters unless filters.empty?
@@ -51,7 +69,10 @@ module Gridspace
         scope_uri << "?#{url_encode(params)}" unless params.empty?
       end
 
-      def generate(ttl = 3600)
+      # Generate a capability token with an expiration date.
+      # *Args*:
+      #   - +expires+ -> The token lifetime, in seconds. Defaults to 1 hour (3600)
+      def generate(expires = 3600)
         capabilities = @capabilities.clone # we need a local copy to work on
 
         # build the outgoing scope lazily so that we can use @client_name
@@ -63,8 +84,8 @@ module Gridspace
 
         payload = {
           'scope' => capabilities.join(' '),
-          'iss' => @account_sid,
-          'exp' => (Time.now.to_i + ttl),
+          'iss' => @account_id,
+          'exp' => (Time.now.to_i + expires),
         }
 
         JWT.encode payload, @auth_token

data/lib/gridspace/version.rb

@@ -1,3 +1,3 @@
 module Gridspace
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gridspace
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Gridspace