assembly-client 0.7.0

data/lib/assembly/config.rb

@@ -0,0 +1,25 @@
+module Assembly
+  class Config
+
+    attr_accessor :host, :auth_host, :token, :refresh_token, :client_id, :client_secret, :api_version
+
+    def initialize(options={})
+      @host         = "https://api.assembly.education"
+      @auth_host    = "https://platform.assembly.education"
+      @api_version  = 1
+      merge(options)
+    end
+
+    def copy_with_overrides(options={})
+      copy = self.dup
+      copy.merge(options)
+      copy
+    end
+
+    def merge(options)
+      options.each do |key, value|
+        send(:"#{key}=", value)
+      end
+    end
+  end
+end

data/lib/assembly/faraday_middleware/assembly_oauth2.rb

@@ -0,0 +1,25 @@
+require 'faraday'
+require 'forwardable'
+
+module FaradayMiddleware
+  class AssemblyOAuth2 < Faraday::Middleware
+    AUTH_HEADER = 'Authorization'.freeze
+
+    attr_reader :token
+
+    def call(env)
+      env[:request_headers][AUTH_HEADER] ||= "Bearer #{token}"
+      @app.call env
+    end
+
+    def initialize(app, token)
+      unless token && token.is_a?(String)
+        raise ArgumentError.new("An access_token string was expected, got: #{token.inspect}")
+      end
+      super(app)
+      @token = token
+    end
+  end
+end
+
+Faraday::Request.register_middleware(assembly_oauth2: FaradayMiddleware::AssemblyOAuth2)

data/lib/assembly/model.rb

@@ -0,0 +1,109 @@
+module Assembly
+  class Model
+    include Enumerable
+
+    undef :id if method_defined?(:id)
+    undef :name if method_defined?(:name)
+
+    attr_reader :id
+    attr_reader :client
+
+    def initialize(id=nil, client=nil)
+      @id = id
+      @client = client
+      @values = {}
+      @dirty_values = Set.new
+    end
+
+    def merge(values, client=nil)
+      added = Set.new(values.keys - @values.keys)
+      add_accessors(added)
+      values.each do |k, v|
+        @values[k] = Util.build(v, client)
+      end
+      self
+    end
+
+    def self.construct_from(response, client=nil)
+      new(response[:id], client).merge(response, client)
+    end
+
+    def update_from(response)
+      @dirty_values.clear
+      merge(response)
+    end
+
+    def dirty?
+      @dirty_values.any?
+    end
+
+    def [](k)
+      @values[k.to_sym]
+    end
+
+    def []=(k, v)
+      send(:"#{k}=", v)
+    end
+
+    def keys
+      @values.keys
+    end
+
+    def values
+      @values.values
+    end
+
+    def to_json(*a)
+      JSON.generate(@values)
+    end
+
+    def as_json(*a)
+      @values.as_json(*a)
+    end
+
+    def to_hash
+      @values.inject({}) do |acc, (key, value)|
+        acc[key] = value.respond_to?(:to_hash) ? value.to_hash : value
+        acc
+      end
+    end
+
+    def each(&blk)
+      @values.each(&blk)
+    end
+
+    def self.class_name
+      self.name.split('::')[-1]
+    end
+
+    def dirty_params
+      @dirty_values.reduce({}) do |hsh, k|
+        hsh[k] = @values[k]
+        hsh
+      end
+    end
+
+    protected
+
+    def metaclass
+      class << self; self; end
+    end
+
+    def add_accessors(keys)
+      keys.each do |k|
+        next if k == :id
+        next if self.class.instance_methods(false).include?(k)
+        self.class.class_eval %[
+          def #{k}
+            @values[:#{k}]
+          end
+
+          def #{k}=(v)
+            @values[:#{k}] = v
+            @dirty_values.add(:#{k})
+          end
+        ]
+      end
+    end
+  end
+end

data/lib/assembly/models/academic_year.rb

@@ -0,0 +1,7 @@
+module Assembly
+  class AcademicYear < ApiModel
+    include Assembly::Actions::List
+  end
+
+  Resource.build(AcademicYear)
+end

data/lib/assembly/models/aspect.rb

@@ -0,0 +1,10 @@
+module Assembly
+  class Aspect < ApiModel
+    include Assembly::Actions::Read
+    include Assembly::Actions::List
+    include Assembly::Actions::Create
+    include Assembly::Actions::Delete
+  end
+
+  Resource.build(Aspect)
+end

data/lib/assembly/models/assessment.rb

@@ -0,0 +1,18 @@
+module Assembly
+  class Assessment < ApiModel
+    include Assembly::Actions::Read
+    include Assembly::Actions::List
+  
+    def grade_set(params={})
+      response = client.get(path + '/grade_set', params)
+      Util.build(response[:grade_set], client)
+    end
+
+    def results(params={})
+      response = client.get(path + '/results', params)
+      Util.build(response, client)
+    end
+  end
+
+  Resource.build(Assessment)
+end

data/lib/assembly/models/assessment_point.rb

@@ -0,0 +1,12 @@
+module Assembly
+  class AssessmentPoint < ApiModel
+    include Assembly::Actions::Read
+    include Assembly::Actions::List
+
+    def results(params={})
+      pages(path + "#{rank}/results", params)
+    end
+  end
+
+  Resource.build(AssessmentPoint)
+end

data/lib/assembly/models/attendance.rb

@@ -0,0 +1,7 @@
+module Assembly
+  class Attendance < ApiModel
+    include Assembly::Actions::List
+  end
+
+  Resource.build(Attendance)
+end

data/lib/assembly/models/calendar_event.rb

@@ -0,0 +1,7 @@
+module Assembly
+  class CalendarEvent < ApiModel
+    include Assembly::Actions::List
+  end
+
+  Resource.build(CalendarEvent)
+end

data/lib/assembly/models/contact.rb

@@ -0,0 +1,7 @@
+module Assembly
+  class Contact < ApiModel
+    include Assembly::Actions::List
+  end
+
+  Resource.build(Contact)
+end

data/lib/assembly/models/exclusion.rb

@@ -0,0 +1,7 @@
+module Assembly
+  class Exclusion < ApiModel
+    include Assembly::Actions::List
+  end
+
+  Resource.build(Exclusion)
+end

data/lib/assembly/models/facet.rb

@@ -0,0 +1,8 @@
+module Assembly
+  class Facet < ApiModel
+    include Assembly::Actions::Read
+    include Assembly::Actions::List
+  end
+
+  Resource.build(Facet)
+end

data/lib/assembly/models/grade.rb

@@ -0,0 +1,4 @@
+module Assembly
+  class Grade < Model
+  end
+end

data/lib/assembly/models/grade_set.rb

@@ -0,0 +1,9 @@
+module Assembly
+  class GradeSet < ApiModel
+    include Assembly::Actions::Read
+    include Assembly::Actions::Create
+    include Assembly::Actions::List
+  end
+
+  Resource.build(GradeSet)
+end

data/lib/assembly/models/list.rb

@@ -0,0 +1,31 @@
+module Assembly
+  class List < Model
+    def each(&blk)
+      self.data.each(&blk)
+    end
+
+    def next
+      self
+    end
+
+    def next_page
+      @values[:next_page]
+    end
+
+    def prev_page
+      @values[:prev_page]
+    end
+
+    def current_page
+      @values[:current_page] || 1
+    end
+
+    def total_pages
+      @values[:total_pages] || 1
+    end
+
+    def total_count
+      @values[:total_count] || 0
+    end
+  end
+end

data/lib/assembly/models/registration_group.rb

@@ -0,0 +1,13 @@
+module Assembly
+  class RegistrationGroup < ApiModel
+    include Assembly::Actions::Read
+    include Assembly::Actions::List
+
+    def students(params={})
+      response = client.get(path + '/students', params)
+      Util.build(response, client)
+    end
+  end
+
+  Resource.build(RegistrationGroup)
+end

data/lib/assembly/models/result.rb

@@ -0,0 +1,11 @@
+module Assembly
+  class Result < ApiModel
+    include Assembly::Actions::Read
+    include Assembly::Actions::List
+    include Assembly::Actions::Create
+    include Assembly::Actions::Delete
+    include Assembly::Actions::Update
+  end
+
+  Resource.build(Result)
+end

data/lib/assembly/models/school_detail.rb

@@ -0,0 +1,7 @@
+module Assembly
+  class SchoolDetail < ApiModel
+    include Assembly::Actions::List
+  end
+
+  Resource.build(SchoolDetail)
+end

data/lib/assembly/models/staff_member.rb

@@ -0,0 +1,8 @@
+module Assembly
+  class StaffMember < ApiModel
+    include Assembly::Actions::Read
+    include Assembly::Actions::List
+  end
+
+  Resource.build(StaffMember)
+end

data/lib/assembly/models/student.rb

@@ -0,0 +1,8 @@
+module Assembly
+  class Student < ApiModel
+    include Assembly::Actions::Read
+    include Assembly::Actions::List
+  end
+
+  Resource.build(Student)
+end

data/lib/assembly/models/subject.rb

@@ -0,0 +1,7 @@
+module Assembly
+  class Subject < ApiModel
+    include Assembly::Actions::List
+  end
+
+  Resource.build(Subject)
+end

data/lib/assembly/models/teaching_group.rb

@@ -0,0 +1,13 @@
+module Assembly
+  class TeachingGroup < ApiModel
+    include Assembly::Actions::Read
+    include Assembly::Actions::List
+
+    def students(params={})
+      response = client.get(path + '/students', params)
+      Util.build(response, client)
+    end
+  end
+
+  Resource.build(TeachingGroup)
+end

data/lib/assembly/models/year_group.rb

@@ -0,0 +1,13 @@
+module Assembly
+  class YearGroup < ApiModel
+    include Assembly::Actions::Read
+    include Assembly::Actions::List
+
+    def students(params={})
+      response = client.get(path + '/students', params)
+      Util.build(response, client)
+    end
+  end
+
+  Resource.build(YearGroup)
+end

data/lib/assembly/resource.rb

@@ -0,0 +1,65 @@
+module Assembly
+  class Resource
+    def initialize(client)
+      @client = client
+    end
+
+    def self.build(model_class)
+      Assembly.const_set("#{model_class.class_name.split(':').last}Resource", resource_class_for(model_class))
+    end
+
+    def self.resource_class_for(model_class)
+      Class.new(Assembly::Resource) do
+        @model_class = model_class
+
+        def self.model_class
+          @model_class
+        end
+
+        def model_class
+          self.class.model_class
+        end
+
+        if model_class.included_modules.include?(Assembly::Actions::Create)
+          def create(params)
+            model_class.create(params, @client)
+          end
+        end
+
+        if model_class.included_modules.include?(Assembly::Actions::Read)
+          def fetch(id, params={})
+            model_class.fetch(id, params, @client)
+          end
+          alias_method :find, :fetch
+        end
+
+        if model_class.included_modules.include?(Assembly::Actions::List)
+          def list(params={})
+            model_class.list(params, @client)
+          end
+
+          def all(params={})
+            model_class.all(params, @client)
+          end
+
+          def total_count(params={})
+            model_class.total_count(params, @client)
+          end
+        end
+
+        if model_class.included_modules.include?(Assembly::Actions::Update)
+          def update(id, params)
+            model_class.update(id, params, @client)
+          end
+        end
+
+        if model_class.included_modules.include?(Assembly::Actions::Delete)
+          def delete(id)
+            model_class.delete(id, @client)
+          end
+        end
+
+      end
+    end
+  end
+end