regis 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTk1MjgwNDEwODYyOGZjNGJhZTkwOTBmNzNiNWRkNWQzYTA3NTZiMQ==
+    YzMxNTA1YmRmMzkwNGIxZmRkNzUzMTA3YTdiZTBhMGE4ZDdjZWYyNw==
   data.tar.gz: !binary |-
-    Y2I4N2FjN2M1NzZhN2YxYTZmZGVjOGZkNDk1MGQyZDA2MjlmMzllMw==
+    NTBmZTAxYmE1ZmYxYmExNTdlYzkzZjVlMDY4NDgxNDI1MjY1ODlhZQ==
 SHA512:
   metadata.gz: !binary |-
-    NTU1NGU1ODVlMTU0ZjZhMjU4MTkzOTVlYTE3OTg0MGQ3YWViNmQ3YmY1ZmJl
-    ZjNmN2FlYzRjMWFhMTRjODA2ODg5MmUwMzllMWQ1ZmIxYzlkYWVkZGU4Y2Rk
-    MGZiMTIxMGE0ZjUwZDUwYTIzNTMyN2U2MDdkMDIzNzhjOTQyNzI=
+    NDJiMTBhODY3ZDJjYzk4Y2QyZDFmZTZjZjFiNWNlOTJiOWJkYzYyODk0OWM0
+    MmZmZWVkZjQ1NDUxYWNjYjFlZTBkZjJiNjg5Y2FjYTUwZDU3OGNmYzZmMWEy
+    MzA5N2I0MzU4ZjlkZWJlZDQ4NGFmMTJlMzQ3OGE5MWRlZWZmYWE=
   data.tar.gz: !binary |-
-    N2EwMjQyMzk5NmY2N2JiY2Y2ZWNlYmY2MjU1NTI1MmY0MTUzMDRjN2I0YmQ0
-    ZWY5MmM3YmRjODdmY2ViZGE1NGQ3ODViZTBlMzM5YTUxZDcwNjczMzZkYjFj
-    MTY5OWNlNjQ4YzU5MmExMTA4MzM0NzkyOTdiZjdmM2MwMTY3OTQ=
+    M2ZmMzk2OGJmYjU5ZjhjYzEzMTk0MjI3Njk4YzRjYWQyYmQzZmI5ZjBkMzRi
+    ZDg2Zjg2YTVjYzRhZGRmMmQ1MmMwZTVlYzE4OWFiYTI1N2VkMTA2ODVkNWJi
+    MDdiNzVmOWM0YTFmYmI4OGU4YzQ3ZTBjMzAzZDNiZDdlNGJmOWU=

data/.gitignore

@@ -31,9 +31,10 @@ build/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
+Gemfile.lock
+.ruby-version
+.ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+Gemfile.lock

data/Gemfile

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

data/README.md

@@ -16,11 +16,37 @@ Or install it yourself as:
 
     $ gem install regis
 
-# Configuration
+Responses are cached with Dalli which requires memcached
+
+    $ apt-get install memcached
+
+## Configuration
 
 Set config/regis_api.yml
-Set features/config/test_values.yml
+
+```
+require 'regis'
+
+$REGIS_API = YAML.load_file("config/regis_api.yml")
+
+Regis.client.configure do |config|
+  config.url = $REGIS_API['url']
+  config.username = $REGIS_API['username']
+  config.password = $REGIS_API['password']
+  config.cache = Regis::Cache.new(Dalli::Client.new('localhost:11211', { :namespace => "regis", :compress => true, :expires_in => 3600 }))
+end
+```
 
 ## Usage
 
-See features/step_definitions/api_steps
+See features/step_definitions/api_steps
+
+## Caching
+
+All responses are cached based on the request URL. So, all endpoints must include variables in the URL itself.
+
+## Testing
+
+Set features/config/test_values.yml
+
+    $ cucumber

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+task :default => :test
+
+task :test => [:cucumber]

data/config/initializers/regis.rb

@@ -0,0 +1,10 @@
+require 'regis'
+
+$REGIS_API = YAML.load_file("config/regis_api.yml")
+
+Regis.client.configure do |config|
+  config.url = $REGIS_API['url']
+  config.username = $REGIS_API['username']
+  config.password = $REGIS_API['password']
+  config.cache = Regis::Cache.new(Dalli::Client.new('localhost:11211', { :namespace => "regis", :compress => true, :expires_in => 3600 }))
+end

data/config/regis_api.example.yml

@@ -0,0 +1,3 @@
+url: 'https://some.url.com'
+username: "some_username"
+password: "some_password"

data/features/config/test_values.example.yml

@@ -0,0 +1,2 @@
+reporting_term: "some_reporting_term"
+section_uuid: "some_section_uuid"

data/features/regis_api.feature

@@ -0,0 +1,22 @@
+Feature: regis api can connect
+  In order to use the REGIS api
+  I want to be able to connect
+
+Scenario: search sections
+    When I search for sections
+    Then I should receive a list of sections
+    
+Scenario: retrieve section
+    When I ask for a section
+    Then I should receive the section I asked for
+    
+Scenario: section values are populated
+    When I ask for a section
+    Then I should have populated section values
+    
+Scenario: api is cached
+    When I reset the section cache
+    And I ask for a section
+    Then I should receive the section I asked for
+    When I ask for a section
+    Then I should have a cached response

data/features/step_definitions/api_steps.rb

@@ -0,0 +1,32 @@
+When /^I search for sections$/ do
+  @response = Regis.client.sections_get_by_reporting_term($REGIS_TEST_VALUES['reporting_term'])
+end
+
+Then /^I should receive a list of sections$/ do
+  expect(@response.sections.count > 0).to be true
+end
+
+When /^I reset the section cache$/ do
+  Regis.client.configuration.cache.delete("/Section/Admin/#{$REGIS_TEST_VALUES['section_uuid']}?format=json")
+end
+
+When /^I ask for a section$/ do
+  @response = Regis.client.section_get_by_uuid($REGIS_TEST_VALUES['section_uuid'])
+end
+
+Then /^I should receive the section I asked for$/ do
+  expect(@response.section.uuid == $REGIS_TEST_VALUES['section_uuid']).to be true
+end
+
+Then /^I should have populated section values$/ do
+  expect(@response.section.uuid).not_to be_empty
+  expect(@response.section.reporting_term).not_to be_empty
+  expect(@response.section.course_name).not_to be_empty
+  expect(@response.section.title).not_to be_empty
+  expect(@response.section.min_credits).to be > 0
+end
+
+Then /^I should have a cached response$/ do
+  response = Regis.client.configuration.cache.read("/Section/Admin/#{$REGIS_TEST_VALUES['section_uuid']}?format=json")
+  expect(response).to be_instance_of(Faraday::Response)
+end

data/features/support/env.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'rspec'
+
+require 'yaml'
+
+require_relative '../../config/initializers/regis'
+
+$REGIS_TEST_VALUES = YAML.load_file("features/config/test_values.yml")

data/lib/regis.rb

@@ -0,0 +1,11 @@
+# Regis API
+# shamelessly cloned from https://github.com/Yelp/yelp-ruby
+
+require 'regis/version'
+require 'regis/client'
+
+module Regis
+    def self.client
+        @client ||= Regis::Client.new
+    end
+end

data/lib/regis/cache.rb

@@ -0,0 +1,21 @@
+module Regis
+    class Cache
+        attr_accessor :store
+        
+        def initialize(store)
+            @store = store
+        end
+
+        def write(key, value)
+            @store.set(key, value)
+        end
+
+        def read(key)
+            @store.get(key)
+        end
+        
+        def delete(key)
+            @store.delete(key)
+        end
+    end
+end

data/lib/regis/client.rb

@@ -0,0 +1,78 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday-cookie_jar'
+
+require 'dalli'
+
+require 'regis/cache'
+require 'regis/configuration'
+require 'regis/endpoint/section'
+require 'regis/endpoint/sections'
+
+module Regis
+    class Client
+        REQUEST_CLASSES = [ Regis::Endpoint::Section, Regis::Endpoint::Sections ]
+        
+        attr_reader :configuration
+        
+        def initialize(options = nil)
+            @configuration = nil
+            define_request_methods
+            
+            unless options.nil?
+                @configuration = Configuration.new(options)
+            end
+        end
+        
+        def configure
+            @configuration = Configuration.new
+            yield(@configuration)
+        end
+                
+        def connection
+            return @connection if instance_variable_defined?(:@connection)
+            @connection = Faraday.new(@configuration.url, :ssl => {:verify => false}) do |faraday|
+                faraday.basic_auth(@configuration.username, @configuration.password)
+                faraday.request :json
+
+                faraday.response :json, :content_type => /\bjson$/
+                #faraday.response :logger
+                
+                faraday.response :caching do
+                    @configuration.cache
+                end
+                                
+                faraday.use :cookie_jar #preserve the servicestack session
+                faraday.adapter Faraday.default_adapter
+            end
+        end
+        
+        private
+
+        # This goes through each endpoint class and creates singletone methods
+        # on the client that query those classes. We do this to avoid possible
+        # namespace collisions in the future when adding new classes
+        def define_request_methods
+            REQUEST_CLASSES.each do |request_class|
+                endpoint_instance = request_class.new(self)
+                create_methods_from_instance(endpoint_instance)
+            end
+        end
+
+        # Loop through all of the endpoint instances' public singleton methods to
+        # add the method to client
+        def create_methods_from_instance(instance)
+            instance.public_methods(false).each do |method_name|
+                add_method(instance, method_name)
+            end
+        end
+
+        # Define the method on the client and send it to the endpoint instance
+        # with the args passed in
+        def add_method(instance, method_name)
+            define_singleton_method(method_name) do |*args|
+                instance.public_send(method_name, *args)
+            end
+        end
+    end
+end

data/lib/regis/configuration.rb

@@ -0,0 +1,8 @@
+module Regis 
+    class Configuration
+        attr_accessor :url
+        attr_accessor :username
+        attr_accessor :password
+        attr_accessor :cache
+    end
+end

data/lib/regis/endpoint/section.rb

@@ -0,0 +1,17 @@
+require 'json'
+require 'regis/responses/section'
+
+module Regis
+    module Endpoint
+        class Section
+            def initialize(client)
+                @client = client
+            end
+                        
+            def section_get_by_uuid(uuid)
+                response = @client.connection.get "/Section/Admin/#{uuid}", { :format => 'json' }
+                Response::Section.new(response.body)
+            end
+        end
+    end
+end

data/lib/regis/endpoint/sections.rb

@@ -0,0 +1,17 @@
+require 'json'
+require 'regis/responses/sections'
+
+module Regis
+    module Endpoint
+        class Sections
+            def initialize(client)
+                @client = client
+            end
+                        
+            def sections_get_by_reporting_term(reporting_term)
+                response = @client.connection.get "/Sections/Admin/#{reporting_term}", { :format => 'json' }
+                Response::Sections.new(response.body)
+            end
+        end
+    end
+end

data/lib/regis/responses/base.rb

@@ -0,0 +1,21 @@
+module Regis
+  module Response
+    class Base
+      def initialize(json)
+        return if json.nil?
+
+        json.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      private
+
+      def parse(json, klass)
+        return json.collect { |j| klass.new(j) } if json.is_a?(Array)
+        return klass.new(json) if json
+        nil
+      end
+    end
+  end
+end

data/lib/regis/responses/models/section.rb

@@ -0,0 +1,40 @@
+require 'regis/responses/base'
+
+module Regis
+    module Response
+        module Model
+            class Section < Response::Base
+                attr_reader :uuid
+                attr_reader :course_name
+                attr_reader :title
+                attr_reader :location
+                attr_reader :room
+                
+                attr_reader :is_audio
+                attr_reader :is_oncampus
+                
+                attr_reader :start_date
+                attr_reader :end_date
+                attr_reader :meeting_days
+                attr_reader :start_times
+                attr_reader :end_times
+                
+                attr_reader :is_weekend
+                attr_reader :is_weekday
+                attr_reader :is_evening
+                attr_reader :is_waitlist
+                
+                attr_reader :is_unlisted           
+                
+                attr_reader :reporting_term
+                attr_reader :min_credits
+                attr_reader :max_credits
+                attr_reader :is_pass_fail                
+                                
+                def initialize(json)
+                    super(json)
+                end
+            end
+        end
+    end
+end

data/lib/regis/responses/section.rb

@@ -0,0 +1,14 @@
+require 'regis/responses/base'
+require 'regis/responses/models/section'
+
+module Regis
+    module Response
+        class Section < Base
+            attr_reader :section
+            
+            def initialize(json)
+                @section = parse(json, Model::Section)
+            end
+        end
+    end
+end

data/lib/regis/responses/sections.rb

@@ -0,0 +1,16 @@
+require 'regis/responses/base'
+require 'regis/responses/models/section'
+
+module Regis
+    module Response
+        class Sections < Base
+            attr_reader :sections
+            
+            def initialize(json)
+                super(json)
+                
+                @sections = parse(@sections, Model::Section)
+            end
+        end
+    end
+end

data/lib/regis/version.rb

@@ -0,0 +1,3 @@
+module Regis
+    VERSION = "0.0.3"
+end

data/regis.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'regis/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'regis'
+  s.required_ruby_version     = '>= 1.9.3'
+  s.add_runtime_dependency 'faraday', '~> 0.8', '>= 0.8.0'
+  s.add_runtime_dependency 'faraday_middleware', '~> 0.8', '>= 0.8.0'
+  s.add_runtime_dependency 'faraday-cookie_jar', '~> 0.0.6', '>= 0.0.6'
+  s.add_runtime_dependency 'faraday-http-cache', '~> 1.2', '>= 1.2.2'
+  s.add_runtime_dependency 'dalli', '~> 2.7', '>= 2.7.0'
+  s.add_development_dependency 'cucumber', '~> 1.3', '>= 1.3.20'
+  s.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
+  s.date        = '2016-01-15'
+  s.summary     = "Ruby API connector"
+  s.description = "The REGIS API as typed models"
+  s.authors     = ["Cameron Tucker"]
+  s.email       = 'ctucker@regent-college.edu'
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {features}/*`.split("\n")
+  s.homepage    = 'https://github.com/RegentCollege/regis-ruby'
+  s.license     = 'AGPL'
+  s.version     = Regis::VERSION
+  s.require_paths = ["lib"]
+  s.test_files  = s.files.grep(%r{^(features)/})
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: regis
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Cameron Tucker
@@ -50,6 +50,66 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: faraday-cookie_jar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -97,8 +157,28 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- Gemfile
 - LICENSE
 - README.md
+- Rakefile
+- config/initializers/regis.rb
+- config/regis_api.example.yml
+- features/config/test_values.example.yml
+- features/regis_api.feature
+- features/step_definitions/api_steps.rb
+- features/support/env.rb
+- lib/regis.rb
+- lib/regis/cache.rb
+- lib/regis/client.rb
+- lib/regis/configuration.rb
+- lib/regis/endpoint/section.rb
+- lib/regis/endpoint/sections.rb
+- lib/regis/responses/base.rb
+- lib/regis/responses/models/section.rb
+- lib/regis/responses/section.rb
+- lib/regis/responses/sections.rb
+- lib/regis/version.rb
+- regis.gemspec
 homepage: https://github.com/RegentCollege/regis-ruby
 licenses:
 - AGPL
@@ -123,4 +203,8 @@ rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby API connector
-test_files: []
+test_files:
+- features/config/test_values.example.yml
+- features/regis_api.feature
+- features/step_definitions/api_steps.rb
+- features/support/env.rb