xporter_on_demand 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8f95f8eb066154b26d9af9347204d471d2118b738b814a3cee21b73420b52ed
-  data.tar.gz: 8512ffd4570508bf6ff60db8ca591259bf7ec56336527e74d734488ad3db1fc3
+  metadata.gz: 2650748b5f2276cc4f3b0be0eeea8b7f7ce2e3c95ca22ecde37521d5863e53d4
+  data.tar.gz: 6e2e16eb2a12043f080cb67ce7c29ec495796193cbd3acef48ef2493b19e0a3b
 SHA512:
-  metadata.gz: 62e4ba2f8b38fbf9858e2f31f502a69b331a986e9becff20f7a824ab5e7f6b3c04d71b64d03d3f14df9dc979eb03edf7b2346ab53053eee9f43bf5c9e7f3ada5
-  data.tar.gz: a5b5522e4b962afc488d9a1d99aafdeb65a107478799c94b511cf78eb5189474d0239d1d10e7c4202ba50d7aa79df68eae97bf0ac7fbd019cb6ee29c96907a4c
+  metadata.gz: a1c2e2f64d3fb7fa4b6a7aa9809820531d6668688b14cd0b34efcef969d280c1bc016844988325a87167574b46a2c33894926df84433625c9e02269c4540afc4
+  data.tar.gz: 8fb6f4e7fbc24cca17be7788757151a99729db6afcdd481450c73f5fb99c7bec189838205d86aac9120d6a2889398c9d4720d52b26b2e1268ccf4b2f0243051c

data/README.md

@@ -26,3 +26,51 @@ student_results = client.query(students_endpoint)
 # Retrieve all pages
 student_results.fetch_all
 ```
+
+## Using the Invitation API
+
+```ruby
+
+# Create your registration object
+reg = XporterOnDemand::Registration.new do |r|
+  r.registration_type     = 'Test' # Defaults to 'Live'
+  r.partner_id            = 'your-partner-id'
+  r.app_management_secret = 'your-app-management-secret'
+end
+
+# Build your school with at the required parameters
+school = {
+  lea_code: 123,                                          # Required
+  dfes_code: 4567,                                        # Required
+  school_name: 'Test School',                             # Required
+  school_contact_first_name: 'Joe',                       # Required
+  school_contact_last_name: 'Bloggs',                     # Required
+  school_contact_email: 'joe.bloggs@email.com',           # Required
+  school_contact_phone: '01234 567890',                   # Required
+  school_contact: 'Joe Bloggs',
+  school_technical_contact_name: 'Jim Bloggs',
+  school_technical_contact_email: 'jim.bloggs@email.com',
+  school_technical_contact_phone: '01234 567890',
+  partner_application_id: 'your-partner-id',              # Required
+  partner_name: 'your-registered-name',                   # Required
+  partner_registered_email: 'your-registered-email',      # Required
+  we_accept_groupcall_usage_policy: true,                 # Required
+}
+
+# Add school to the registration object. Multiple schools can be added
+reg.add_school(school)
+
+# Send registrations
+reg.register
+
+# Will return a boolean outlining whether or not ALL registrations were successful.
+# Any error messages will be assigned to the registration object or the
+# individual schools eg.
+
+reg.message
+# => 'Unauthorized: ApplicationId header missing or incorrect'
+
+reg.schools.first.message
+# => 'School not found in EduBase'
+
+```

data/lib/xporter_on_demand/registration.rb

@@ -0,0 +1,110 @@
+require 'xporter_on_demand/utils'
+require 'base64'
+
+module XporterOnDemand
+  class Registration
+    include XporterOnDemand::Utils
+
+    attr_reader :schools, :message
+    attr_accessor :registration_type, :partner_id, :app_management_secret
+
+    SCHOOL_ATTRIBUTES = %i(
+      lea_code
+      dfes_code
+      school_name
+      school_contact_first_name
+      school_contact_last_name
+      school_contact_email
+      school_contact_phone
+      school_contact
+      school_technical_contact_name
+      school_technical_contact_email
+      school_technical_contact_phone
+      partner_application_id
+      partner_name
+      partner_registered_email
+      scopes_to_authorise
+      we_accept_groupcall_usage_policy
+    )
+
+    School = Struct.new(*SCHOOL_ATTRIBUTES) do
+      attr_accessor :status, :message
+
+      def camelize
+        to_h.transform_keys{ |k| k.to_s.camelcase }.reject{ |_k, v| v.nil? || (String === v && v.empty?) }
+      end
+    end
+
+    def initialize(args = {})
+      @schools = Set.new
+
+      if block_given?
+        yield self
+      else
+        @registration_type     = args[:registration_type] || 'Live'
+        @partner_id            = args[:partner_id]
+        @app_management_secret = args[:app_management_secret]
+      end
+    end
+
+    def add_school(param_hash = {})
+      attributes = SCHOOL_ATTRIBUTES.each_with_object({}) do |key, hash|
+        hash[key] = param_hash[key]
+      end
+
+      if School.const_defined? 'ActiveModel::Model'
+        @schools << School.new.tap{ |s| s.assign_attributes attributes }
+      else
+        @schools << School.new(*attributes.values)
+      end
+    end
+
+    def register
+      timestamp = DateTime.current.strftime("%FT%T")
+      auth = generate_hash(timestamp: timestamp)
+
+      args = {
+        url: REGISTRATION_PATH,
+        headers: {
+          'ApplicationId': @partner_id,
+          'DateTime': timestamp,
+          'Authorization': "Groupcall #{auth}",
+        },
+        body: to_json,
+      }
+
+      response = post(args)
+
+      if response['Schools']
+        response['Schools'].all? do |school|
+          s = get_school(school['LeaCode'], school['DfesCode'])
+          s.status = school['Status']
+          s.message = school['Message']
+
+          school['Status'] == 'OK'
+        end
+      else
+        @message = response['Message']
+        false
+      end
+    end
+
+    def get_school(lea, dfes)
+      @schools.find{ |sch| sch.lea_code == lea && sch.dfes_code == dfes }
+    end
+
+    def to_json
+      { Schools: @schools.map(&:camelize), RegistrationType: @registration_type }.to_json
+    end
+
+    def generate_hash(secret: @app_management_secret, timestamp:, content: to_json)
+      raise ArgumentError, 'Must supply your App Management Secret' unless secret
+      raise ArgumentError, 'Must supply at least one school' if @schools.empty?
+
+      b64 = Base64.strict_encode64(content + timestamp + secret)
+
+      sha256 = OpenSSL::Digest.new('sha256')
+      OpenSSL::HMAC.hexdigest(sha256, secret, b64).upcase
+    end
+  end
+end

data/lib/xporter_on_demand/token.rb

@@ -1,6 +1,7 @@
 module XporterOnDemand
   class Token < Client
     def initialize(*args)
+      @loaded = false
       @options = args.last.is_a?(Hash) ? args.pop : {}
       @options[:url] ||= STS_PATH
 
@@ -14,7 +15,20 @@ module XporterOnDemand
     def retrieve
       result = post(@options.merge(body: @request_body.to_json))
       assign_attributes(result)
+      @loaded =  true
       self
     end
+
+    def validate
+      dont_raise_exception{ retrieve }
+
+      if token
+        :valid
+      elsif try(:authorisation_paused)
+        :paused
+      else
+        :invalid
+      end
+    end
   end
 end

data/lib/xporter_on_demand/utils.rb

@@ -18,7 +18,7 @@ module XporterOnDemand
 
     def handle_exceptions(response)
       response_body = JSON.parse(response.body || {})
-      raise response_body["ExceptionMessage"] if response_body["ExceptionMessage"]
+      raise response_body["ExceptionMessage"] if response_body["ExceptionMessage"] && !@dont_raise_exception
     end
 
     def parameterize(sym)
@@ -68,5 +68,12 @@ module XporterOnDemand
         enum
       end
     end
+
+    def dont_raise_exception
+      @dont_raise_exception = true
+      yield
+    ensure
+      @dont_raise_exception = false
+    end
   end
 end

data/lib/xporter_on_demand/version.rb

@@ -1,3 +1,3 @@
 module XporterOnDemand
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/lib/xporter_on_demand.rb

@@ -14,9 +14,11 @@ require 'xporter_on_demand/version'
 require 'xporter_on_demand/result/base'
 require 'xporter_on_demand/result/result_set'
 require 'xporter_on_demand/result/serialiser'
+require 'xporter_on_demand/registration'
 
 module XporterOnDemand
-  API_PATH  = "https://xporter.groupcall.com/api/v1/"
-  STS_PATH  = "https://login.groupcall.com/idaas/sts/STS/GetToken"
-  META_KEYS = %w(ChangedRows DbStatus Meta Pagination)
+  API_PATH          = "https://xporter.groupcall.com/api/v1/"
+  STS_PATH          = "https://login.groupcall.com/idaas/sts/STS/GetToken"
+  META_KEYS         = %w(ChangedRows DbStatus Meta Pagination)
+  REGISTRATION_PATH = "https://manage.groupcall.com/API/XporterOnDemand/SchoolRegister"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xporter_on_demand
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Jordan Green
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-29 00:00:00.000000000 Z
+date: 2019-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpi
@@ -28,20 +28,20 @@ dependencies:
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.8.3
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.8.3
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.3
 - !ruby/object:Gem::Dependency
@@ -120,6 +120,7 @@ files:
 - lib/xporter_on_demand/client.rb
 - lib/xporter_on_demand/endpoint.rb
 - lib/xporter_on_demand/factory.rb
+- lib/xporter_on_demand/registration.rb
 - lib/xporter_on_demand/result/base.rb
 - lib/xporter_on_demand/result/result_set.rb
 - lib/xporter_on_demand/result/serialiser.rb
@@ -146,8 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for the Xporter on Demand API.