progresso 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b042d6f7ebb1625c8d007a75f9596cda09da0529
+  data.tar.gz: 136fc38ba249c4055c432acc377780dd2dd03e66
+SHA512:
+  metadata.gz: c6941986f342d9c5df046fe6d122e3c1c77f58dcea11e74271759cc6e0a282f1c26c7a855c76716fa126d1b885e0ca3ac3f47416f6ae1dce02964d6be2020da5
+  data.tar.gz: f314473f9cc23454b9acce1eeea4835b41423e4f954b2e65f1099dfaf282f1dda2b4ce4a7116808ec6728d8c6f5289814af5b56dd3be6df313990bf9ddf7258d

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in progresso.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    progresso (0.1.0)
+      activesupport (>= 4)
+      excon (>= 0.45)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    excon (0.62.0)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  progresso!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,36 @@
+# Progresso
+
+Progresso API client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'progresso'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install progresso
+
+## Usage
+
+    client = Progresso::Client.new(subdomain, username, password)
+    client.learners.each do |student|
+      puts "#{student.forename} #{student.surname}"
+    end
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/progresso.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "progresso"
+
+# 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/progresso.rb

@@ -0,0 +1,5 @@
+require "progresso/version"
+require "progresso/client"
+
+module Progresso
+end

data/lib/progresso/client.rb

@@ -0,0 +1,141 @@
+require "excon"
+require "json"
+require "progresso/token"
+require "progresso/errors"
+require "active_support/core_ext/string"
+
+module Progresso
+  class Client
+    def initialize(subdomain, username, password)
+      @url = "https://#{subdomain}.progresso.net/v2"
+      @username = username
+      @password = URI.encode(password)
+    end
+
+    %w(
+      employees
+      employee_contacts
+      staff_absences
+      employee_checks
+      contacts
+      learners
+      learner_other_details
+      learner_contacts
+      learner_health
+      learner_exclusions
+      learner_sen_provisions
+      learner_sen_major_needs
+      learner_siblings
+      document
+      roll_call_times
+      attendance_codes
+      learner_roll_call_attendance
+      learner_lesson_attendance
+      get_photo
+      udf
+      udf_values
+      assessment_screens
+      learner_assessment_result
+      learner_sats_result
+      learner_assessment_cats_data
+      learner_assessment_cat4_data
+      learner_assessment_kS2fft_data
+      learner_exam_option_result
+      groups
+      group_association
+      school
+      academic_year
+      academic_terms
+      term_breaks
+      week_structure
+      academic_calendar_events
+      courses
+      course_year
+      subjects
+      pay_scales
+      tt_sources
+      day_structures
+      date_mappings
+      day_compositions
+      day_compositions_periods
+      week_ranges
+      tt_events
+      employee_tt_events
+      room_categories
+      room_types
+      rooms
+      site
+      bm_events
+      bm_configuration
+      bm_staff_on_behalf
+      bm_assign_to
+      detention_event
+      bm_structure
+    ).each do |resource|
+      define_method resource do |options = {}|
+        resource = resource.split('_').map {|w| w.capitalize}.join
+        response = http_request_with_token("/#{resource}", params: options)
+
+        content_type = response.headers["Content-Type"].match(/^(\w*\/\w*)/)[1]
+
+        case response.status
+        when 204
+          []
+        when 404
+          raise InvalidRequestError, response.body
+        when 200
+          JSON.parse(response.body)
+        end
+      end
+    end
+
+    private
+      def http_request_with_token path, options = {}
+        fetch_token if !@token || @token.expired?
+
+        options[:headers] ||= {}
+        options[:headers]['Authorization'] = "Bearer #{@token.token}"
+
+        http_get_request path, options
+      end
+
+      def fetch_token
+        response = http_post_request "/Token",
+          params: {
+            username: @username,
+            password: @password,
+            grant_type: 'password'
+          },
+          headers: {
+            'Content-Type' => 'application/x-www-form-urlencoded'
+          }
+
+        if response.status != 200
+          raise InvalidCredentialsError, "Username or password incorrect"
+        end
+
+        json = JSON.parse(response.body)
+
+        @token = Token.new(json)
+      end
+
+      def http_post_request path, options = {}
+        Excon.post(
+          "#{@url}#{path}",
+          body: URI.encode_www_form(options[:params]),
+          headers: options[:headers]
+        )
+      end
+
+      def http_get_request path, options = {}
+        Excon.get(
+          "#{@url}#{path}?#{URI.encode_www_form(options[:params])}",
+          headers: options[:headers]
+        )
+      end
+
+      def handle_exceptions(body, parsed_body)
+        StringIO.new(parsed_body["error"] + ", " + parsed_body["message"]) unless [200, 201].include?(body)
+      end
+  end
+end

data/lib/progresso/errors.rb

@@ -0,0 +1,4 @@
+module Progresso
+  InvalidCredentialsError = Class.new(StandardError)
+  InvalidRequestError = Class.new(StandardError)
+end

data/lib/progresso/token.rb

@@ -0,0 +1,16 @@
+require 'date'
+
+module Progresso
+  class Token
+    attr_reader :token
+
+    def initialize(json)
+      @token = json['access_token']
+      @expires = DateTime.strptime(json['.expires'], '%a, %d %b %Y %H:%M:%S %Z')
+    end
+
+    def expired?
+      @expires < DateTime.now
+    end
+  end
+end

data/lib/progresso/version.rb

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

data/progresso.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "progresso/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "progresso"
+  spec.version       = Progresso::VERSION
+  spec.authors       = ["Hakim Aryan"]
+  spec.email         = ["hakim.aryan@cpoms.co.uk"]
+
+  spec.summary       = %q{Progresso API client}
+  spec.homepage      = "http://www.cpoms.co.uk"
+
+  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 "excon", '>= 0.45'
+  spec.add_runtime_dependency 'activesupport', ">= 4"
+
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: progresso
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hakim Aryan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.45'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !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'
+description: 
+email:
+- hakim.aryan@cpoms.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/progresso.rb
+- lib/progresso/client.rb
+- lib/progresso/errors.rb
+- lib/progresso/token.rb
+- lib/progresso/version.rb
+- progresso.gemspec
+homepage: http://www.cpoms.co.uk
+licenses: []
+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: Progresso API client
+test_files: []