faria-launchpad-api 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 141b8fba57f02ac17ef852773ddf56acb6fbc9ec
-  data.tar.gz: e61ca8770a32d3104bed67fb303cf0e1000d2194
+  metadata.gz: 83d8f5483e9d09348b69ee459d246e3097c9cacf
+  data.tar.gz: 6879e2cf106c9fba214e3a3949a06174ecb1ed6e
 SHA512:
-  metadata.gz: 4deb81abb926841e0fa08f536d101dff4ba50dab9418d40c8e7d3f02f3df58a9ce5d7b247f9a87b826fc721804081819eee52d141b148dfd5e82d3f19867c8e3
-  data.tar.gz: 9dadac9c644080901b0b77da335e5729fb5ba4cd4718fd92d92ac56bdf94fafc9130900f0a9fb3345cc084e2c2e763bf084fb588d393e27660717e36aced5812
+  metadata.gz: 34f5889ccc831569547183d3e90f48840308ae0242efc1bc57c63bac5234435fd3e63778b2c8e7add7a07bc232a9d379336fb774b9079cad29aab7815dce56f9
+  data.tar.gz: d0daf6985bad5984e22706d0d2fc7972fd069ba92cc8707341201cff918d81fb970b8d4056da2c691f83743c04b9cf75d622f7d1e5ee224a3ced1fca3ef916fd

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Release History:
+
+## 0.2.1 - 26 September 2016
+
+- First public release
+
+## 0.2.2 - 3 January 2017
+
+- Updated JWE/JWT dependencies

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Josh Goebel
+Copyright (c) 2016 Faria Education Group
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -61,7 +61,7 @@ kQIDAQAB
 
 #### Serving your public key inside your application
 
-The LaunchPad spec also requires that your web application serve this public key (text/plaintext) over HTTPs as part of the API your application must furnish to fully support LaunchPad.
+The LaunchPad spec also requires that your web application serve this public key (text/plaintext) over HTTPS as part of the API your application must furnish to fully support LaunchPad.
 
     GET https://yourapplication.com/apis/launchpad/pubkey
     -----BEGIN PUBLIC KEY-----
@@ -79,17 +79,17 @@ Here is a quick example. This example presumes you've already generated a 2,048
 
 
 ```ruby
-    # fetch the LaunchPad public key 
-    # (you should probably save it locally rather than constantly fetch it)
-    uri = "https://devel.launchpad.managebac.com/api/v1/"
-    launchpad_key = Net::HTTP.get_response(URI.parse(url + "pubkey")).body
+    # fetch the LaunchPad public key
+# (you should save it locally rather than constantly fetch it)
+    uri = "https://launchpad.launchpad-staging.managebac.com/api/v1/"
+    launchpad_key = Net::HTTP.get_response(URI.parse(uri + "pubkey")).body
     local_key = OpenSSL::PKey::RSA.new(File.read("./secure/private_key"))
 
-    @service = Faria::Launchpad::Service.new(
-      "https://devel.launchpad.managebac.com/api/v1/",
+    service = Faria::Launchpad::Service.new(
+      "https://launchpad.launchpad-staging.managebac.com/api/v1/",
       {
         keys: { local: local_key, remote: launchpad_key },
-        # the application name and URI issued to you during your 
+        # the application name and URI issued to you during your
         # LaunchPad setup process
         source: {
           name: "Acme Widgets, LLC.",
@@ -110,7 +110,7 @@ The responses returned will almost always be JSON responses (see [API documentat
 
 ### Rails Integration
 
-There is a module to extend controllers to support easily handling incoming JWE requests and a Rails helper to assist with POSTing signed redirects.   Below is a usage example.
+There is a module to extend controllers to support easily handling incoming JWE requests and a Rails helper to assist with POSTing signed redirects.  Below is a usage example.
 
 If the URL includes query parameters they will be stripped from the URL and encoded into the JWE as signed parameters.
 
@@ -147,12 +147,12 @@ The `SSO` module below is just one example of how you might wrap up all the piec
     class YourController < ActionController::Base
       include Faria::Launchpad::Controller
       launchpad_config SSO
-      
+
       def action
-        post_encrypted_redirect_to SSO.client.pairing_request_url, 
+        post_encrypted_redirect_to SSO.client.pairing_request_url,
           params_to_pass
       end
-      
+
     end
 ```
 
@@ -172,4 +172,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/eduvo/
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/faria-launchpad-api.gemspec

@@ -6,8 +6,8 @@ require 'faria/launchpad/api/version'
 Gem::Specification.new do |spec|
   spec.name          = "faria-launchpad-api"
   spec.version       = Faria::Launchpad::Api::VERSION
-  spec.authors       = ["Josh Goebel"]
-  spec.email         = ["me@joshgoebel.com"]
+  spec.authors       = ["Faria Education Group"]
+  spec.email         = ["rubygems@fariaedu.com"]
 
   spec.summary       = %q{Ruby library to interface with Faria LaunchPad.}
   spec.description   = %q{Ruby library to interface with Faria LaunchPad, including an API client and Rails helpers.}
@@ -35,11 +35,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "pry-byebug", "~> 3.4"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.0"
 
-  # need 1.5.4 since they have been changing the component API a lot in minor
-  # point releases
-  spec.add_dependency "jwt", "~> 1.5.4"
-  spec.add_dependency "jwe", "~> 0.1.0"
+  spec.add_dependency "jwt", "1.5.6"
+  spec.add_dependency "jwe", "0.1.1"
   spec.add_dependency "addressable", "~> 2.4"
   spec.add_dependency "activesupport"
 end

data/lib/faria/launchpad/api/version.rb

@@ -1,7 +1,7 @@
 module Faria
   module Launchpad
     module Api
-      VERSION = "0.2.1"
+      VERSION = "0.2.2"
     end
   end
 end

data/lib/faria/launchpad/packet.rb

@@ -23,7 +23,7 @@ module Faria
         end
       end
 
-      # encrypting is done with Launchpad public key
+      # encrypting is done with LaunchPad public key
       # signing is done with local private key
 
       def self.encrypt(data, options = {}, local_key:, remote_key: )
@@ -39,14 +39,14 @@ module Faria
       end
 
       # for cases where you known in advance the remote key to use (such
-      # as Launchpad clients which will only be receiving messages from
-      # Launchpad and therefore will only use it's public key for verifying
+      # as LaunchPad clients which will only be receiving messages from
+      # LaunchPad and therefore will only use it's public key for verifying
       # signatures
       def self.decrypt(raw_data, options = {}, local_key:, remote_key: )
-        version, jwe = raw_data.split(";", 2)
+        _version, jwe = raw_data.split(";", 2)
         jwt = JWE.decrypt(jwe, local_key)
         arr = JWT.decode(jwt, remote_key, true, { :algorithm => 'RS512' })
-        payload, header = arr
+        payload, _header = arr
 
         # validate_expiration will be handled by JWT decode
         validate_url!(payload, options[:actual_url])
@@ -57,14 +57,14 @@ module Faria
       # for cases where the signature key is not known in advance and must
       # be determined by source information embedded in the JWT header
       def self.decrypt_variable_key(raw_data, options = {}, local_key:, remote_key_func: )
-        version, jwe = raw_data.split(";", 2)
+        _version, jwe = raw_data.split(";", 2)
         jwt = JWE.decrypt(jwe, local_key)
         header, payload = JWT::Decode.new(jwt, nil, false, {}).decode_segments[0..1]
         remote_key = remote_key_func.call(header, payload)
         fail(MissingRemoteKey) if remote_key.nil?
 
         arr = JWT.decode(jwt, remote_key, true, { :algorithm => 'RS512' })
-        payload, header = arr
+        payload, _header = arr
 
         # validate_expiration will be handled by JWT decode
         validate_url!(payload, options[:actual_url])
@@ -72,8 +72,6 @@ module Faria
         payload["data"]
       end
 
-      private
-
       def self.add_source(packet, source)
         packet[:faria_source] = source
         packet

data/lib/faria/launchpad/service.rb

@@ -5,8 +5,6 @@ module Faria
   module Launchpad
     class Service
 
-      LAUNCHPAD_NAME = "Launchpad"
-
       def self.noauth(endpoint, quiet: false)
         unless quiet
           puts "************************************************************************\n" \
@@ -82,8 +80,12 @@ module Faria
         patch "identities/#{uuid}", identity: identity_representation
       end
 
+      def import_identities(api_key, identities)
+        post "identities/import", {school_api_key: api_key, identities: identities}
+      end
+
       # by_value allows the unique pairing value to be used to perform
-      # queries or updates instead of Launchpad's internal UUID
+      # queries or updates instead of LaunchPad's internal UUID
       def show_identity_by_pairing_value(pairing_value)
         get "identities/by_pairing_value/#{pairing_value}"
       end
@@ -153,11 +155,8 @@ module Faria
           payload = encrypt_payload(params, a)
           if verb == :get
             request['Faria-JWE'] = payload
-            debug "Faria-JWE: #{payload}"
           else
             request['Content-Type'] = "application/jwe"
-            debug "Content-Type: application/jwe"
-            debug "POST BODY: #{payload}"
             request.body = payload
           end
           http.request request
@@ -176,10 +175,6 @@ module Faria
 
       private
 
-      def debug(s)
-        puts s
-      end
-
       VALID_VERBS = %w(get put patch post get delete)
 
       # can't guarantee we have Rails or AS so we use eval vs

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faria-launchpad-api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
-- Josh Goebel
+- Faria Education Group
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-26 00:00:00.000000000 Z
+date: 2017-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,33 +53,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: jwt
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.4
-  type: :runtime
+        version: '0.10'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.4
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: jwe
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
-  type: :runtime
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: jwe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -111,13 +167,14 @@ dependencies:
 description: Ruby library to interface with Faria LaunchPad, including an API client
   and Rails helpers.
 email:
-- me@joshgoebel.com
+- rubygems@fariaedu.com
 executables:
 - console
 - setup
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -152,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Ruby library to interface with Faria LaunchPad.