xporter_on_demand 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ceaf91f7c0ce11f34fde81948b9995d0d6ca9897
+  data.tar.gz: a815f2fa6e86d7fafcb1757e9082c8b6ca5b30cb
+SHA512:
+  metadata.gz: 929d0d0e4609629fca2d12742b789e0f5983187a0b7c6fcd6065c2b996fa4313a98d7240606d2c6dc6012c59df409174840ceb007f6418fbb03d3cdc36ed3e9a
+  data.tar.gz: de14cee9e7c8b1fc5b606b9e48cb0b57de480e8ec2bcc82398eb6ea914dad412f36d6289df2aa1ec2673887a4fab5b0ae41da46d734241c2303895f8e2465fd9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in xporter_on_demand.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jordan Green
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# A Ruby client for the [XporterOnDemand API](https://xporter.groupcall.com/)
+
+## Installation
+```
+gem install xod_client
+```
+
+## Getting started
+```ruby
+require 'xporter_on_demand'
+
+relying_party = "app.example.com"   # Your relying party
+school_estab  = "1234567"           # School establishment number
+estab_secret  = "YOUR SECRET HERE"  # Supplied school secret
+
+# Retrieve an IDAAS Authentication token
+token  = XporterOnDemand::Token.new(school_estab, relying_party, estab_secret).retrieve
+# Initialize a client with the token
+client = XporterOnDemand::Client.new(token.token)
+
+# Craft a query with your desired options & parameters
+students_endpoint = XporterOnDemand::Endpoint.create(:students, options: [:include_group_ids, :include_att_stats], parameters: { student_status: 'OnRoll' })
+
+# Fetch the first page of results
+student_results = client.query(students_endpoint)
+# Retrieve all pages
+student_results.fetch_all
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xporter_on_demand"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xporter_on_demand/api.rb

@@ -0,0 +1,32 @@
+module XporterOnDemand
+  module API
+    def fetch(endpoint)
+      raise ArgumentError, "endpoint must contain 'id' parameter" unless endpoint.id
+      create_result_set(get_endpoint(endpoint), endpoint)
+    end
+
+    def query(endpoint)
+      create_result_set(get_endpoint(endpoint), endpoint)
+    end
+
+    def changed_rows(endpoint)
+      raise ArgumentError, "endpoint must contain 'changed_rows' parameter" unless endpoint.parameters[:changed_rows]
+      create_result_set(get_endpoint(endpoint), endpoint)
+    end
+
+    def db_status(resource)
+      create_result_set(get(@uri + resource.to_s.camelize + "/?onlyGetDbStatus=true"))
+    end
+
+    def get_endpoint(endpoint)
+      get(@uri + endpoint.build_query)
+    end
+
+    private
+      def create_result_set(results, endpoint = nil)
+        XporterOnDemand::ResultSet.new(results).tap do |rs|
+          rs.attach_stuff(self, endpoint) if endpoint
+        end
+      end
+  end
+end

data/lib/xporter_on_demand/client.rb

@@ -0,0 +1,43 @@
+require 'httpi'
+require 'json'
+require 'active_support/core_ext/string'
+require 'xporter_on_demand/utils'
+
+module XporterOnDemand
+  class Client
+    include XporterOnDemand::API
+    include XporterOnDemand::Utils
+
+    attr_reader :token, :available_scopes, :estab, :uri
+
+    def initialize(token = nil, args = {})
+      @token            = token
+      @args             = args
+
+      details           = token_details
+      @available_scopes = details["Scopes"]
+      @estab            = @args.delete(:estab)
+      @estab            ||= details["Estab"]
+
+      args[:edubase] ? edubase_client : school_client
+    end
+
+    %i(token_details scopes queries logs usage).each do |endpoint|
+      define_method(endpoint){ get_info(endpoint.to_s.camelcase) }
+    end
+
+    def school_client
+      @uri = API_PATH + "School/" + estab + "/"
+    end
+
+    # This is not finished and probably won't even work.
+    def edubase_client
+      @uri = API_PATH + "RunQuery/?"
+    end
+
+    private
+      def get_info(endpoint)
+        get(url: API_PATH + endpoint)
+      end
+  end
+end

data/lib/xporter_on_demand/endpoint.rb

@@ -0,0 +1,53 @@
+require 'xporter_on_demand/factory'
+
+module XporterOnDemand
+  class Endpoint
+    include XporterOnDemand::Utils
+
+    attr_accessor :endpoint, :options, :parameters, :pagination, :uri, :id
+
+    def self.create(endpoint, args = {})
+      endpoint_name = endpoint.to_s.classify
+
+      unless const_defined?(endpoint_name, false)
+        class_name = Class.new(self)
+        endpoint_class = const_set(endpoint_name, class_name)
+      end
+
+      const_get(endpoint_name).new(args).tap do |s|
+        s.instance_variable_set(:@endpoint, endpoint)
+      end
+    end
+
+    def initialize(args = {})
+      @options    = args.fetch(:options, [])
+      @parameters = args.fetch(:parameters, {})
+
+      @parameters[:page]      ||= 1
+      @parameters[:page_size] ||= 25
+
+      @id = args[:id]
+
+      # Check that all the options are valid?
+      # Check that the parameters are valid?
+      # Check the pagination params are valid?
+    end
+
+    def build_query
+      URI.escape(resource + "?" + build_parameters)
+    end
+
+    private
+      def resource
+        endpoint.to_s.camelize + "/" + (@id || "")
+      end
+
+      def build_options
+        @options.any? ? ["options=" + @options.map{ |o| parameterize(o) }.join(',')] : []
+      end
+
+      def build_parameters
+        (@parameters.map{ |k, v| parameterize(k) + "=" + v.to_s } + build_options).join('&')
+      end
+  end
+end

data/lib/xporter_on_demand/factory.rb

@@ -0,0 +1,19 @@
+module XporterOnDemand
+  module Factory
+    def self.create(name, superclass, args = {})
+      i_vars    = args.delete(:i_vars) || {}
+      namespace = args.delete(:namespace) || superclass
+
+      unless namespace.const_defined?(name, false)
+        s_class  = Class.new(superclass)
+        namespace.const_set(name, s_class)
+      end
+
+      namespace.const_get(name).new(args).tap do |klass|
+        i_vars.each do |i_var, value|
+          klass.instance_variable_set(i_var, value)
+        end
+      end
+    end
+  end
+end

data/lib/xporter_on_demand/result/base.rb

@@ -0,0 +1,26 @@
+module XporterOnDemand
+  module Result
+    class Base
+      include XporterOnDemand::Utils
+
+      def initialize(args = {})
+        result = args.delete(:result)
+        assign_attributes(result)
+      end
+
+      def type
+        self.class.name.demodulize
+      end
+
+      def update(other_result)
+        return if other_result.type != type ||\
+                  other_result.id != id ||\
+                  other_result.last_updated <= last_updated
+
+        attributes.each do |attribute|
+          send("#{attribute}=", other_result.send(attribute))
+        end
+      end
+    end
+  end
+end

data/lib/xporter_on_demand/result/result_set.rb

@@ -0,0 +1,82 @@
+module XporterOnDemand
+  class ResultSet
+    include Enumerable
+    include XporterOnDemand::Utils
+
+    attr_accessor :results, :school, :endpoint
+
+    def initialize(result_hash)
+      results = create_results(result_hash)
+      assign_attributes results
+    end
+
+    def each
+      all.each{ |result| yield result }
+    end
+
+    def all
+      attributes.reject{ |a| META_KEYS.include? a.camelcase }.flat_map{ |a| send(a) }
+    end
+
+    def length
+      all.length
+    end
+
+    def fetch_all
+      return self unless try :pagination
+      og_page = pagination.page_number
+
+      pagination.page_count.times do |i|
+        # Skip if we've already got this page
+        next if og_page == i + 1
+
+        endpoint.parameters[:page] = i + 1
+
+        results_hash = create_results(school.get_endpoint(endpoint))
+
+        results_hash.each do |type, results|
+          if META_KEYS.include? type.camelcase
+            assign_attributes(type => results)
+          elsif self.respond_to?(type)
+            results.each do |result|
+              if result.respond_to?(:id) && existing_result = send(type).find{ |r| r.id == result.id }
+                existing_result.update(result)
+              else
+                send(type).append(result)
+              end
+            end
+          else
+            assign_attributes(type => results)
+          end
+        end
+      end
+      self
+    end
+
+    def attach_stuff(sch, ep)
+      self.school = sch
+      self.endpoint = ep.dup
+    end
+
+    private
+      def create_results(result_hash)
+        result_hash.map do |namespace, objects|
+          type = namespace.underscore.camelize
+          result_objects = objects.flat_map{ |object| create_result(type, object) }
+
+          [namespace.underscore, result_objects]
+        end.to_h
+      end
+
+      # def create_result(type, object)
+      #   Factory.create(
+      #     META_KEYS.include?(type) ? type : type.singularize,
+      #     XporterOnDemand::Result::Base,
+      #     {
+      #       namespace: XporterOnDemand::Result,
+      #       result: object
+      #     }
+      #   )
+      # end
+  end
+end

data/lib/xporter_on_demand/result/serialiser.rb

@@ -0,0 +1,57 @@
+module XporterOnDemand
+  module Result
+    class Serialiser
+      FORMAT_REGISTRY = Hash.new{ |h, k| h[k] = { type: :default } }.update(
+        active:                 { type: :boolean },
+        date:                   { type: :date },
+        dateof_birth:           { type: :date },
+        date_of_birth:          { type: :date },
+        date_time:              { type: :date_time },
+        eal:                    { type: :boolean },
+        expires:                { type: :date_time },
+        fsm_eligible:           { type: :boolean },
+        fsm_ever6:              { type: :boolean },
+        gifted:                 { type: :boolean },
+        in_lea_care:            { type: :boolean },
+        last_updated:           { type: :date_time },
+        par_resp:               { type: :boolean },
+        pupil_premium:          { type: :boolean },
+        service_child:          { type: :boolean },
+        uniform_allowance:      { type: :boolean }
+      )
+
+      FORMATTERS = {
+        boolean:   ->(v){ !!v.nonzero? },
+        csv:       ->(v){ v.split(',') rescue [] },
+        date:      ->(v){ Date.parse(v) rescue nil },
+        date_time: ->(v){ DateTime.parse(v) rescue nil },
+        default:   ->(v){ v },
+      }
+
+      def self.serialise(attributes)
+        object_array = attributes.map do |attribute, value|
+          key = attribute.underscore
+          format = get_format(key)
+
+          [key, FORMATTERS[format].call(value)]
+        end
+        object_array.to_h
+      end
+
+      private
+        def self.get_format(key)
+          if key =~ /_ids\z/
+            :csv
+          elsif key =~ /(_?date\z|(start|end)\z)/
+            :date
+          elsif key =~ /_date_time\z/
+            :date_time
+          elsif key =~ /\Ais_/
+            :boolean
+          else
+            FORMAT_REGISTRY[key.to_sym][:type]
+          end
+        end
+    end
+  end
+end

data/lib/xporter_on_demand/token.rb

@@ -0,0 +1,20 @@
+module XporterOnDemand
+  class Token < Client
+    def initialize(*args)
+      @options = args.last.is_a?(Hash) ? args.pop : {}
+      @options[:url] ||= STS_PATH
+
+      @request_body = {}
+      %w(estab relyingParty password thirdpartyid).each_with_index{ |k, i| @request_body[k] = args[i] }
+
+      @request_body["thirdpartyid"] ||= "XporterOnDemand"
+      raise ArgumentError, "must supply all the sniz" unless @request_body.none?{ |k, v| v.nil? }
+    end
+
+    def retrieve
+      result = post(@options.merge(body: @request_body.to_json))
+      assign_attributes(result)
+      self
+    end
+  end
+end

data/lib/xporter_on_demand/utils.rb

@@ -0,0 +1,68 @@
+module XporterOnDemand
+  module Utils
+    [:get, :post].each do |verb|
+      define_method(verb) do |*args|
+        request = configure_request(*args)
+        response = HTTPI.request(verb, request)
+        handle_exceptions(response)
+        JSON.parse(response.body.presence || {})
+      end
+    end
+
+    def configure_request(*args)
+      request = HTTPI::Request.new(*args)
+      request.headers["Content-Type"] = "application/json"
+      request.headers["Authorization"] = "Idaas " + @token if @token
+      request
+    end
+
+    def handle_exceptions(response)
+      response_body = JSON.parse(response.body || {})
+      raise response_body["ExceptionMessage"] if response_body["ExceptionMessage"]
+    end
+
+    def parameterize(sym)
+      sym.to_s.camelize(:lower)
+    end
+
+    def assign_attributes(attributes)
+      unless instance_variable_defined?("@attributes")
+        instance_variable_set("@attributes", [])
+        self.class.send(:attr_reader, :attributes)
+      end
+
+      XporterOnDemand::Result::Serialiser.serialise(attributes).each do |name, value|
+        method_name = name.camelize.underscore
+        unless META_KEYS.include?(name.camelize)
+          method_name = method_name.singularize if value.is_a?(Array) && value.length == 1
+        end
+
+        instance_variable_set("@#{method_name}", unwrap(value))
+        self.class.send(:attr_reader, method_name)
+
+        @attributes |= [method_name]
+      end
+    end
+
+    def create_result(type, object)
+      Factory.create(
+        META_KEYS.include?(type) ? type : type.singularize,
+        XporterOnDemand::Result::Base,
+        {
+          namespace: XporterOnDemand::Result,
+          result: object,
+        }
+      )
+    end
+
+    def unwrap(enum)
+      if enum.is_a?(Array)
+        enum.length <= 1 ? enum.first || [] : enum
+      elsif enum.is_a?(Hash)
+        enum.length == 1 ? unwrap(enum[enum.keys.first]) : enum
+      else
+        enum
+      end
+    end
+  end
+end

data/lib/xporter_on_demand/version.rb

@@ -0,0 +1,3 @@
+module XporterOnDemand
+  VERSION = "0.1.0"
+end

data/lib/xporter_on_demand.rb

@@ -0,0 +1,22 @@
+# require "xporter_on_demand/version"
+# require 'xporter_on_demand/client'
+# require 'xporter_on_demand/token'
+# # require 'xporter_on_demand/utils'
+# require 'xporter_on_demand/result/serialiser'
+
+require 'xporter_on_demand/api'
+require 'xporter_on_demand/client'
+require 'xporter_on_demand/endpoint'
+require 'xporter_on_demand/factory'
+require 'xporter_on_demand/token'
+require 'xporter_on_demand/utils'
+require 'xporter_on_demand/version'
+require 'xporter_on_demand/result/base'
+require 'xporter_on_demand/result/result_set'
+require 'xporter_on_demand/result/serialiser'
+
+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)
+end

data/xporter_on_demand.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "xporter_on_demand/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "xporter_on_demand"
+  spec.version       = XporterOnDemand::VERSION
+  spec.authors       = ["Jordan Green"]
+  spec.email         = ["jordan.green@meritec.co.uk"]
+
+  spec.summary       = %q{Ruby client for the Xporter on Demand API.}
+  spec.homepage      = "https://github.com/meritec/xporter_on_demand"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'httpi', '~> 2.4.2', '>= 2.4.2'
+  # Gotta use httpclient cos net_http don't like the __foo__ JSON keys
+  spec.add_runtime_dependency 'httpclient', '~> 2.8.3', '>= 2.8.3'
+  spec.add_runtime_dependency 'activesupport', '~> 5.0.0.1', '>= 5.0.0.1'
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: xporter_on_demand
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jordan Green
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+- !ruby/object:Gem::Dependency
+  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
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- jordan.green@meritec.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xporter_on_demand.rb
+- lib/xporter_on_demand/api.rb
+- lib/xporter_on_demand/client.rb
+- lib/xporter_on_demand/endpoint.rb
+- lib/xporter_on_demand/factory.rb
+- lib/xporter_on_demand/result/base.rb
+- lib/xporter_on_demand/result/result_set.rb
+- lib/xporter_on_demand/result/serialiser.rb
+- lib/xporter_on_demand/token.rb
+- lib/xporter_on_demand/utils.rb
+- lib/xporter_on_demand/version.rb
+- xporter_on_demand.gemspec
+homepage: https://github.com/meritec/xporter_on_demand
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Ruby client for the Xporter on Demand API.
+test_files: []