edools-api 0.4.0 → 0.5.0

data/lib/edools/paginated_collection.rb

@@ -0,0 +1,37 @@
+require 'active_resource'
+
+module Edools
+  class PaginatedCollection < ActiveResource::Collection
+
+    # Our custom array to handle pagination methods
+    attr_accessor :total_pages, :per_page, :total_count, :current_page
+
+    # The initialize method will receive the ActiveResource parsed result
+    # and set @elements.
+    def initialize(parsed = {})
+      @elements = parsed[resource_key(parsed.keys)]
+      @total_pages = parsed["total_pages"]
+      @per_page = parsed["per_page"]
+      @total_count = parsed["total_count"]
+      @current_page = parsed["current_page"]
+    end
+
+    private
+
+    def resource_key(keys)
+      (Edools.api_objects
+        .collect { |klass| split_class_name_to_key_match(klass) }.flatten & keys).first
+    end
+
+    def split_class_name_to_key_match(klass)
+      resource_key = klass.name.split("::").last.underscore.pluralize
+
+      if resource_key.include?('_')
+        [resource_key, resource_key.gsub('_')]
+      else
+        resource_key
+      end
+    end
+
+  end
+end

data/spec/edools/core/course_content_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Edools::Core::CourseContent, :vcr do
+  it 'finds all course_content' do
+    course_contents = Edools::Core::CourseContent.all(params: { course_module_id: 11329 })
+
+    expect(course_contents.count).to eq 3
+  end
+
+  it 'finds the course_content' do
+    course_content = Edools::Core::CourseContent.find(52239)
+
+    expect(course_content.id).to eq 52239
+  end
+
+  it 'update the course_content' do
+    course_content = Edools::Core::CourseContent.find(52239)
+    course_content.description = 'Edools API Test'
+
+    expect(course_content.save).to eq true
+  end
+
+  it 'create the course_content' do
+    course_content = Edools::Core::CourseContent.new()
+    course_content.prefix_options[:course_module_id] = 11329
+    course_content.name = "Edools API Test"
+
+    expect(course_content.save).to eq true
+  end
+
+  it 'destroy the course_content' do
+    course_content = Edools::Core::CourseContent.find(52239)
+    expect(course_content.destroy).to be_truthy
+  end
+end

data/spec/edools/core/course_module_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Edools::Core::CourseModule, :vcr do
+  it 'finds all course_module' do
+    course_modules = Edools::Core::CourseModule.all(params: { course_id: 1566 })
+
+    expect(course_modules.count).to eq 3
+  end
+
+  it 'finds the course_module' do
+    course_module = Edools::Core::CourseModule.find(11329)
+
+    expect(course_module.id).to eq 11329
+  end
+
+  it 'update the course_module' do
+    course_module = Edools::Core::CourseModule.find(11329)
+    course_module.description = 'Edools API TEST'
+
+    expect(course_module.save).to eq true
+  end
+
+  it 'create the course_module' do
+    course_module = Edools::Core::CourseModule.new()
+    course_module.prefix_options[:course_id] = 1566
+    course_module.name = "Teste"
+
+    expect(course_module.save).to eq true
+  end
+
+  it 'destroy the course_module' do
+    course_module = Edools::Core::CourseModule.find(11976)
+    expect(course_module.destroy).to be_truthy
+  end
+end

data/spec/edools/core/course_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Edools::Core::Course, :vcr do
+  it 'finds the course' do
+    course = Edools::Core::Course.find(12473)
+
+    expect(course.id).to eq 12473
+  end
+
+  it 'finds all course' do
+    courses = Edools::Core::Course.all
+    expect(courses.count).to eq 10
+    expect(courses.per_page). to eq 10
+    expect(courses.current_page). to eq 1
+    expect(courses.total_count). to eq 49
+    expect(courses.total_pages). to eq 5
+  end
+
+  it 'update the course' do
+    course = Edools::Core::Course.find(12473)
+    course.description = 'Edools API test'
+
+    expect(course.save).to be_truthy
+  end
+
+  it 'create the course' do
+    course = Edools::Core::Course.new(name: 'Edools API Test')
+
+    expect(course.save).to be_truthy
+  end
+
+  it 'destroy the course' do
+    course = Edools::Core::Course.find(12473)
+    expect(course.destroy).to be_truthy
+  end
+end

data/spec/edools/core/enrollment_spec.rb

@@ -22,12 +22,10 @@ describe Edools::Core::Enrollment, :vcr do
 
   it 'create the enrollment' do
     student = Edools::Core::Student.find(:first)
-    school_class = Edools::Core::SchoolClass.find(:first, params: { school_product_id: 156 })
 
-    enrollment = Edools::Core::Enrollment.new()
+    enrollment = Edools::Core::Enrollment.new
 
     enrollment.registration_id = student.registrations.first.id
-    enrollment.school_class_id = school_class.id
     enrollment.unlimited = true
     enrollment.status = 'active'
 

data/spec/edools/core/lesson_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Edools::Core::Lesson, :vcr do
+  it 'finds all lesson' do
+    lessons = Edools::Core::Lesson.all
+
+    expect(lessons.count).to eq 10
+    expect(lessons.per_page). to eq 10
+    expect(lessons.current_page). to eq 1
+    expect(lessons.total_count). to eq 381
+    expect(lessons.total_pages). to eq 39
+  end
+
+  it 'finds the lesson' do
+    lesson = Edools::Core::Lesson.find(52232)
+
+    expect(lesson.id).to eq 52232
+  end
+
+  it 'update the lesson' do
+    lesson = Edools::Core::Lesson.find(52232)
+    lesson.description = 'Edools API Test'
+
+    expect(lesson.save).to eq true
+  end
+
+  it 'create the lesson' do
+    lesson = Edools::Core::Lesson.new()
+    lesson.title = "Edools API Test"
+    lesson.type = 'ContentLesson'
+
+    expect(lesson.save).to eq true
+  end
+
+  it 'destroy the lesson' do
+    lesson = Edools::Core::Lesson.find(52232)
+    expect(lesson.destroy).to be_truthy
+  end
+end

data/spec/edools/core/media_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Edools::Core::Media, :vcr do
+  it 'finds all media' do
+    all_media = Edools::Core::Media.all
+
+    expect(all_media.count).to eq 10
+    expect(all_media.per_page). to eq 10
+    expect(all_media.current_page). to eq 1
+    expect(all_media.total_count). to eq 639
+    expect(all_media.total_pages). to eq 64
+  end
+
+  it 'finds the media' do
+    media = Edools::Core::Media.find(54344)
+
+    expect(media.id).to eq 54344
+  end
+
+  it 'update the media' do
+    media = Edools::Core::Media.find(54344)
+    media.description = 'Edools API Test'
+
+    expect(media.save).to eq true
+  end
+
+  it 'create the media' do
+    media = Edools::Core::Media.new()
+    media.title = "Edools API Test"
+    media.type = 'Text'
+    media.text = 'Edools API Test Text'
+
+    expect(media.save).to eq true
+  end
+
+  it 'destroy the media' do
+    media = Edools::Core::Media.find(54344)
+    expect(media.destroy).to be_truthy
+  end
+end

data/spec/edools/core/path_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Edools::Core::Path, :vcr do
+  it 'finds the path' do
+    path = Edools::Core::Path.find(1008)
+
+    expect(path.id).to eq 1008
+  end
+
+  it 'finds all path' do
+    paths = Edools::Core::Path.all
+    expect(paths.count).to eq 10
+    expect(paths.per_page). to eq 10
+    expect(paths.current_page). to eq 1
+    expect(paths.total_count). to eq 20
+    expect(paths.total_pages). to eq 2
+  end
+
+  it 'update the path' do
+    path = Edools::Core::Path.find(1008)
+    path.description = 'Edools API test'
+
+    expect(path.save).to be_truthy
+  end
+
+  it 'create the path' do
+    path = Edools::Core::Path.new(name: 'Edools API Test')
+
+    expect(path.save).to be_truthy
+  end
+
+  it 'destroy the path' do
+    path = Edools::Core::Path.find(1750)
+    expect(path.destroy).to be_truthy
+  end
+end

data/spec/edools/core/school_product_spec.rb

@@ -4,18 +4,22 @@ describe Edools::Core::SchoolProduct, :vcr do
   it 'finds all school product' do
     school_products = Edools::Core::SchoolProduct.all(params: { school_id: 224 })
 
-    expect(school_products.count).to eq 8
+    expect(school_products.count).to eq 10
+    expect(school_products.per_page). to eq 10
+    expect(school_products.current_page). to eq 1
+    expect(school_products.total_count). to eq 73
+    expect(school_products.total_pages). to eq 8
   end
 
   it 'finds the school product' do
-    school_product = Edools::Core::SchoolProduct.find(170)
+    school_product = Edools::Core::SchoolProduct.find(2718)
 
-    expect(school_product.id).to eq 170
+    expect(school_product.id).to eq 2718
   end
 
   it 'update the school product' do
-    school_product = Edools::Core::SchoolProduct.find(170)
-    school_product.description = "test description"
+    school_product = Edools::Core::SchoolProduct.find(2718)
+    school_product.description = "Edools API Test"
 
     expect(school_product.save).to eq true
   end
@@ -29,7 +33,7 @@ describe Edools::Core::SchoolProduct, :vcr do
   end
 
   it 'destroy the school product' do
-    school_product = Edools::Core::SchoolProduct.find(170)
+    school_product = Edools::Core::SchoolProduct.find(2718)
     expect(school_product.destroy.code).to eq '204'
   end
 end

data/spec/edools/ecommerce/base_spec.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Edools::Ecommerce::Base do
+  describe 'location' do
+    it 'sets site to edools ecommerce api url' do
+      expect(Edools::Ecommerce::Base.site.to_s).to eq 'https://ecommerce.edools.com'
+    end
+  end
+end

data/spec/edools/ecommerce/product_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Edools::Ecommerce::Product, :vcr do
+  it 'finds all product' do
+    products = Edools::Ecommerce::Product.all(params: { school_id: 224 })
+
+    expect(products.count).to eq 10
+    expect(products.per_page). to eq 10
+    expect(products.current_page). to eq 1
+    expect(products.total_count). to eq 109
+    expect(products.total_pages). to eq 11
+  end
+
+  it 'finds the product' do
+    product = Edools::Ecommerce::Product.find(123)
+
+    expect(product.id).to eq 2671
+  end
+
+  it 'update the product' do
+    product = Edools::Ecommerce::Product.find(123)
+    product.name = "Edools API Test UPDATED"
+
+    expect(product.save).to eq true
+  end
+
+  it 'create the product' do
+    product = Edools::Ecommerce::Product.new(name: 'Edools API Test', guid: '123', price: 0)
+    product.prefix_options[:school_id] = 224
+
+    expect(product.save).to eq true
+  end
+
+  it 'destroy the product' do
+    product = Edools::Ecommerce::Product.find(123)
+    expect(product.destroy.code).to eq '204'
+  end
+end

data/spec/fixtures/vcr_cassettes/Edools_Core_Course/create_the_course.yml

@@ -0,0 +1,66 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://core.edools.com/courses.json
+    body:
+      encoding: UTF-8
+      string: '{"course":{"name":"Edools API Test"}}'
+    headers:
+      Content-Type:
+      - application/json
+      Authorization:
+      - Token token=84cc0400cd52f62f2e12309b502889ab:2fee1e06d56ab6394ab9acd4c6a8c62f
+      Accept:
+      - application/vnd.edools.core.v1+json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Security-Policy-Report-Only:
+      - default-src https://* 'self'; connect-src https://* 'self'; font-src https://*
+        'self'; frame-src https://* 'self'; img-src https://* 'self' data:; media-src
+        https://* 'self'; object-src https://* 'self'; script-src https://* 'self';
+        style-src https://* 'self'; report-uri https://core.edools.com/uri-directive;
+      Content-Type:
+      - application/vnd.edools.core.v1+json; charset=utf-8
+      Date:
+      - Mon, 06 Jul 2015 18:40:47 GMT
+      Etag:
+      - '"05afd31daad949eabd999d7e754075da"'
+      Location:
+      - https://core.edools.com/courses/12473
+      Server:
+      - nginx/1.4.7
+      Status:
+      - 201 Created
+      Strict-Transport-Security:
+      - max-age=631152000; includeSubdomains
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - DENY
+      X-Request-Id:
+      - ec4f7799-873a-459a-87e5-a64ab64fa1d0
+      X-Runtime:
+      - '0.143671'
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '295'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"id":12473,"name":"Edools API Test","description":null,"image_url":null,"created_at":"2015-07-06
+        18:40:47 UTC","updated_at":"2015-07-06 18:40:47 UTC","duration":null,"path_ids":[],"forum_section_ids":[],"library_resource":{"id":121410,"school_products":[],"library":{"id":2},"library_tags":[]}}'
+    http_version: 
+  recorded_at: Mon, 06 Jul 2015 18:40:47 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/vcr_cassettes/Edools_Core_Course/destroy_the_course.yml

@@ -0,0 +1,114 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://core.edools.com/courses/12473.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.edools.core.v1+json
+      Authorization:
+      - Token token=84cc0400cd52f62f2e12309b502889ab:2fee1e06d56ab6394ab9acd4c6a8c62f
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Security-Policy-Report-Only:
+      - default-src https://* 'self'; connect-src https://* 'self'; font-src https://*
+        'self'; frame-src https://* 'self'; img-src https://* 'self' data:; media-src
+        https://* 'self'; object-src https://* 'self'; script-src https://* 'self';
+        style-src https://* 'self'; report-uri https://core.edools.com/uri-directive;
+      Content-Type:
+      - application/vnd.edools.core.v1+json; charset=utf-8
+      Date:
+      - Mon, 06 Jul 2015 18:42:56 GMT
+      Etag:
+      - '"d46b4517d247df7aa7e2c4b7514d6fb0"'
+      Server:
+      - nginx/1.4.7
+      Status:
+      - 200 OK
+      Strict-Transport-Security:
+      - max-age=631152000; includeSubdomains
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - DENY
+      X-Request-Id:
+      - 9b9d2f4b-9d47-4fc6-9129-e97165453597
+      X-Runtime:
+      - '0.071172'
+      X-Xss-Protection:
+      - 1; mode=block
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"id":12473,"name":"Edools API Test","description":"Edools API test","image_url":null,"created_at":"2015-07-06
+        18:40:47 UTC","updated_at":"2015-07-06 18:42:43 UTC","duration":null,"path_ids":[],"forum_section_ids":[],"library_resource":{"id":121410,"school_products":[],"library":{"id":2},"library_tags":[]}}'
+    http_version: 
+  recorded_at: Mon, 06 Jul 2015 18:42:56 GMT
+- request:
+    method: delete
+    uri: https://core.edools.com/courses/12473.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.edools.core.v1+json
+      Authorization:
+      - Token token=84cc0400cd52f62f2e12309b502889ab:2fee1e06d56ab6394ab9acd4c6a8c62f
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Security-Policy-Report-Only:
+      - default-src https://* 'self'; connect-src https://* 'self'; font-src https://*
+        'self'; frame-src https://* 'self'; img-src https://* 'self' data:; media-src
+        https://* 'self'; object-src https://* 'self'; script-src https://* 'self';
+        style-src https://* 'self'; report-uri https://core.edools.com/uri-directive;
+      Date:
+      - Mon, 06 Jul 2015 18:42:56 GMT
+      Server:
+      - nginx/1.4.7
+      Status:
+      - 204 No Content
+      Strict-Transport-Security:
+      - max-age=631152000; includeSubdomains
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - DENY
+      X-Request-Id:
+      - 58b36f65-150b-40e2-ad51-9790eeb4af2a
+      X-Runtime:
+      - '0.100044'
+      X-Xss-Protection:
+      - 1; mode=block
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 06 Jul 2015 18:42:56 GMT
+recorded_with: VCR 2.9.2