one45 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16dc956d8f62c8d9d3e2f891d57b92c9a74a9bb2
-  data.tar.gz: cd6ce58c8b2faca3a4ba250a9a219d4ba1e06f46
+  metadata.gz: 31da719f0b6cb4f24314e92b73345ab9a8f5bb87
+  data.tar.gz: 3fbe55869abc7ebf3c00f041f07f427fc6e3928f
 SHA512:
-  metadata.gz: e13dd53ac33f7c098fa29230195184c613d4d53042ee5b4ca8864da1f05089c1a37c540ec30a26f0c1162f1effdb02d9aa0456ebc196babfa0cbcc6de08d9acd
-  data.tar.gz: 742d0d3585d0df43c780920e2fa628f8fda980564419e6b3b9eb3e6e4b5a6ab391f61723367f59f42c0a7760102c1fc9c82c044df2e75bfdcb4bee9120e21765
+  metadata.gz: 3c82f215abddc305473ab2e16ca9f7bd142824148b1eb7a64395f55eb6a19253fc70bc2af8313cbd77f9518388fbc83e0a79b430d67f0a711c5c41c9eb61d1c7
+  data.tar.gz: 18351382c8ff60616eca7dde859071e239e8264cf36e49776e985ce1148fe9ef820fa68be729703419cd2d300d4778fed94afde20ef98fcdd5a8566978dcc55f

data/README.md

@@ -2,7 +2,7 @@
 
 Ruby bindings for the [one45 API](https://api.one45.com/api/docs/all).
 
-Under development since most endpoints remain listed as Early Access/In Development.
+Under development since most endpoints remain listed as `Early Access/In Development`.
 
 ## Installation
 
@@ -31,10 +31,10 @@ One45.client_secret = ENV['ONE45_CLIENT_SECRET']
 One45.access_token  = ENV['ONE45_ACCESS_TOKEN'] # optional
 ```
 
-A request for a new token will be made prior to each call if no access token provided (which is slowing response).
+A request for a new token will be made prior to each call if no access token provided (which is slowing down response time).
 In future, an alternate solution would be to implement OAuth2 strategy.
 
-Retrieve collection
+### Retrieving a collection of objects (users, groups, forms...)
 
 ```
 One45::Evaluations.list(
@@ -47,18 +47,32 @@ One45::Evaluations.list(
 )
 ```
 
-Fetch specific record by One45 ID
+### Retrieving a single object
+
+Fetch specific record by its One45 ID
 
 ```
 One45::Questions.find(504)
 ```
 
+### Entities Implemented
+
+Entity | Methods
+--     | --
+Evaluation | list, find, answers, contributors, question_answers
+Event | ahd_events, ahd_event, ahd_attendees, curriculum_events, curriculum_event, curriculum_event_attendees, curriculum_event_children, rotation_events, rotation_event, rotation_attendees
+Form | list, find, groups, questions
+Group | list, find, subgroups
+Question | list, find
+Rotation | list, find
+People (as user) | list, find, preferences, todos, evaluations
+
 __Current limits__
 
-- Only GET methods so far (POST, DELETE, PATCH, PUT are excluded at the moment)
-- Only token#generate is implemented
+- Support for GET methods only at the moment (POST, DELETE, PATCH, PUT are excluded)
+- Regarding token entity, only token#generate method is implemented through `One45.generate_token(One45.client_key, One45.client_secret)`
 
-For complete list of implementation please refer to test file.
+For complete implementation please refer to the test file.
 
 ## Development
 

data/lib/one45.rb

@@ -8,6 +8,7 @@ require "one45/base"
 
 # API resources
 require "one45/evaluations"
+require "one45/events"
 require "one45/forms"
 require "one45/groups"
 require "one45/questions"
@@ -32,7 +33,7 @@ module One45
         # puts "generated access_token: #{@access_token}"
         @access_token
       rescue => e
-        One45Error.new("error: #{e.class} : #{e.response} : #{e.response}")
+        One45Error.new("#{e.class} - #{e.response}")
       end
     end
 

data/lib/one45/events.rb

@@ -0,0 +1,64 @@
+module One45
+  class Events < Base
+
+    def self.academic_half_day_events(options = {})
+      url = "#{resource_url}/ahd"
+      One45.get url
+    end
+    singleton_class.send(:alias_method, :ahd_events, :academic_half_day_events)
+
+    def self.academic_half_day_event(id)
+      url = "#{resource_url}/ahd/#{id}"
+      One45.get url
+    end
+    singleton_class.send(:alias_method, :ahd_event, :academic_half_day_event)
+
+    def self.academic_half_day_attendees(id)
+      url = "#{resource_url}/ahd/#{id}/attendees"
+      One45.get url
+    end
+    singleton_class.send(:alias_method, :ahd_attendees, :academic_half_day_attendees)
+
+    def self.curriculum_events(options = {})
+      url = "#{resource_url}/curriculum"
+      One45.get url
+    end
+
+    def self.curriculum_event(id)
+      url = "#{resource_url}/curriculum/#{id}"
+      One45.get url
+    end
+
+    def self.curriculum_event_attendees(id)
+      url = "#{resource_url}/curriculum/#{id}/attendees"
+      One45.get url
+    end
+
+    def self.curriculum_event_children(id)
+      url = "#{resource_url}/curriculum/#{id}/children"
+      One45.get url
+    end
+
+    def self.rotation_events(options = {})
+      url = "#{resource_url}/rotation"
+      One45.get url
+    end
+
+    def self.rotation_event(id)
+      url = "#{resource_url}/rotation/#{id}"
+      One45.get url
+    end
+
+    def self.rotation_attendees(id)
+      url = "#{resource_url}/rotation/#{id}/attendees"
+      One45.get url
+    end
+
+    private
+
+      def self.resource_url
+        "events"
+      end
+
+  end
+end

data/lib/one45/version.rb

@@ -1,3 +1,3 @@
 module One45
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: one45
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Olivier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-27 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -127,6 +127,7 @@ files:
 - lib/one45/base.rb
 - lib/one45/errors/one45_error.rb
 - lib/one45/evaluations.rb
+- lib/one45/events.rb
 - lib/one45/forms.rb
 - lib/one45/groups.rb
 - lib/one45/questions.rb