edools-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3eade3c23eee728077692f503d70ba857c08046
-  data.tar.gz: 5091623e13c4f66a376c337444a29e92ff01798f
+  metadata.gz: d56f4560d47d60772bd66ba32a6070704247b05a
+  data.tar.gz: 5832b7c3890b0bb29d94135bee8bfbb8969ba002
 SHA512:
-  metadata.gz: 554440efb0345b30a1374dc8df8e6f4ec24b292d2dfd8c5c6fff7fec4a62531c8377da9162a10d458919f1858b401d408fe3a6d7109718ed735882c548881ccf
-  data.tar.gz: d9d1bdf18515517ba422e2fa5c54481525bb92299d7207a4366623af9ea22c75fedb784ba9f7a7e284f0fa1b818c61166ca120422b60d9845526def719b84b70
+  metadata.gz: feb27b20f54868075b9a80a8b3f9a0f6f1c259887fc09aa4a9cbb6d08e67b3dd480f18b49e3d7399cf48fa458339520a64b0e2f97d53746d9d76f2fd1b37de94
+  data.tar.gz: bc1a1ff5a8b93d03f556d07107472da4542408fe3959f8dd054273ffbccf1be59e88dfe1a73acbc717529f322d2d678ccc35080c6eeda4d992d28d18106384df

data/.editorconfig

@@ -0,0 +1,21 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.rb]
+indent_style = space
+indent_size = 2
+
+[Rakefile]
+indent_style = space
+indent_size = 2
+
+[Gemfile*]
+indent_style = space
+indent_size = 2
+

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/edools-api.gemspec

@@ -0,0 +1,121 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: edools-api 0.2.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "edools-api"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Vinicius Kastrup"]
+  s.date = "2014-07-30"
+  s.description = "\n    With this gem you'll be able to access and manipulate all the data of your School or Organization\n    hosted at Edools.\n  "
+  s.email = "viniciusmkm@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".editorconfig",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "edools-api.gemspec",
+    "lib/edools.rb",
+    "lib/edools/config.rb",
+    "lib/edools/core.rb",
+    "lib/edools/core/base.rb",
+    "lib/edools/core/enrollment.rb",
+    "lib/edools/core/organization.rb",
+    "lib/edools/core/paginated_collection.rb",
+    "lib/edools/core/registration.rb",
+    "lib/edools/core/school.rb",
+    "lib/edools/core/school_class.rb",
+    "lib/edools/core/school_product.rb",
+    "lib/edools/core/student.rb",
+    "lib/edools/initialization.rb",
+    "spec/edools/core/base_spec.rb",
+    "spec/edools/core/enrollment_spec.rb",
+    "spec/edools/core/organization_spec.rb",
+    "spec/edools/core/registration_spec.rb",
+    "spec/edools/core/school_class_spec.rb",
+    "spec/edools/core/school_product_spec.rb",
+    "spec/edools/core/school_spec.rb",
+    "spec/edools/core/student_spec.rb",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Enrollment/create_the_enrollment.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Enrollment/finds_all_enrollment.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Enrollment/finds_the_enrollment.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Enrollment/update_the_enrollment.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_School/create_the_school.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_School/finds_all_school.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_School/finds_the_school.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_School/update_the_school.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_SchoolClass/create_the_school_class.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_SchoolClass/destroy_the_school_class.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_SchoolClass/finds_all_school_class.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_SchoolClass/finds_the_school_class.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_SchoolClass/update_the_school_class.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_SchoolProduct/create_the_school_product.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_SchoolProduct/destroy_the_school_product.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_SchoolProduct/finds_all_school_product.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_SchoolProduct/finds_the_school_product.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_SchoolProduct/update_the_school_product.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Student/create_the_student.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Student/destroy_the_student.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Student/finds_all_student.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Student/finds_the_student.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Student/update_the_student.yml",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/Edools/edools-api"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "This gem is a Ruby wrapper for all Edools API's"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activeresource>, [">= 4.0.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.0.0"])
+      s.add_development_dependency(%q<vcr>, ["~> 2.9.2"])
+      s.add_development_dependency(%q<webmock>, ["~> 1.18.0"])
+      s.add_development_dependency(%q<pry>, ["~> 0.10.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<activeresource>, [">= 4.0.0"])
+      s.add_dependency(%q<rspec>, ["~> 3.0.0"])
+      s.add_dependency(%q<vcr>, ["~> 2.9.2"])
+      s.add_dependency(%q<webmock>, ["~> 1.18.0"])
+      s.add_dependency(%q<pry>, ["~> 0.10.0"])
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activeresource>, [">= 4.0.0"])
+    s.add_dependency(%q<rspec>, ["~> 3.0.0"])
+    s.add_dependency(%q<vcr>, ["~> 2.9.2"])
+    s.add_dependency(%q<webmock>, ["~> 1.18.0"])
+    s.add_dependency(%q<pry>, ["~> 0.10.0"])
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/edools/core.rb

@@ -3,5 +3,6 @@ require 'edools/core/enrollment'
 require 'edools/core/organization'
 require 'edools/core/registration'
 require 'edools/core/school'
+require 'edools/core/school_class'
 require 'edools/core/school_product'
 require 'edools/core/student'

data/lib/edools/core/enrollment.rb

@@ -5,6 +5,16 @@ module Edools
   module Core
     class Enrollment < Edools::Core::Base
       self.collection_parser = PaginatedCollection
+
+      def self.collection_path(prefix_options = {}, query_options = nil)
+        super
+        student_id = prefix_options[:student_id] || query_options.try(:[], :student_id)
+        if student_id
+          "/students/#{student_id}/#{collection_name}.#{format.extension}#{query_string(query_options)}"
+        else
+          "/#{collection_name}.#{format.extension}#{query_string(query_options)}"
+        end
+      end
     end
   end
 end

data/lib/edools/core/organization.rb

@@ -4,7 +4,7 @@ require 'edools/core/paginated_collection'
 module Edools
   module Core
     class Organization < Edools::Core::Base
-      self.collection_parser = PaginatedCollection
+      # self.collection_parser = PaginatedCollection
     end
   end
 end

data/lib/edools/core/registration.rb

@@ -4,7 +4,7 @@ require 'edools/core/paginated_collection'
 module Edools
   module Core
     class Registration < Edools::Core::Base
-      self.collection_parser = PaginatedCollection
+      # self.collection_parser = PaginatedCollection
     end
   end
 end

data/lib/edools/core/school.rb

@@ -4,7 +4,7 @@ require 'edools/core/paginated_collection'
 module Edools
   module Core
     class School < Edools::Core::Base
-      self.collection_parser = PaginatedCollection
+      # self.collection_parser = PaginatedCollection
     end
   end
 end

data/lib/edools/core/school_class.rb

@@ -0,0 +1,14 @@
+require 'edools/core/base'
+require 'edools/core/paginated_collection'
+
+module Edools
+  module Core
+    class SchoolClass < Edools::Core::Base
+      def self.collection_path(prefix_options = {}, query_options = nil)
+        super
+        school_product_id = prefix_options[:school_product_id] || query_options.try(:[], :school_product_id)
+        "/school_products/#{school_product_id}/#{collection_name}.#{format.extension}#{query_string(query_options)}"
+      end
+    end
+  end
+end

data/lib/edools/core/school_product.rb

@@ -4,7 +4,13 @@ require 'edools/core/paginated_collection'
 module Edools
   module Core
     class SchoolProduct < Edools::Core::Base
-      self.collection_parser = PaginatedCollection
+      # self.collection_parser = PaginatedCollection
+
+      def self.collection_path(prefix_options = {}, query_options = nil)
+        super
+        school_id = prefix_options[:school_id] || query_options.try(:[], :school_id)
+        "/schools/#{school_id}/#{collection_name}.#{format.extension}#{query_string(query_options)}"
+      end
     end
   end
 end

data/lib/edools/core/student.rb

@@ -1,11 +1,14 @@
 require 'edools/core/base'
 require 'edools/core/paginated_collection'
+require 'edools/core/enrollment'
 
 module Edools
   module Core
     class Student < Edools::Core::Base
       self.collection_parser = PaginatedCollection
 
+      has_many :enrollments, class_name: 'edools/core/enrollment'
+
       def to_json(options={})
         super(include_root_in_json ? { root: 'user' }.merge(options) : options)
       end

data/spec/edools/core/enrollment_spec.rb

@@ -1,33 +1,36 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Edools::Core::Enrollment, :vcr do
-  xit 'finds the enrollment' do
-    enrollment = Edools::Core::Enrollment.find(1249)
+  it 'finds all enrollment' do
+    enrollments = Edools::Core::Enrollment.all(params: { student_id: 1024 })
 
-    expect(enrollment.id).to eq 1249
+    expect(enrollments.count).to eq 2
   end
 
-  xit 'finds all enrollment' do
-    enrollments = Edools::Core::Enrollment.all
+  it 'finds the enrollment' do
+    enrollment = Edools::Core::Enrollment.find(1035)
 
-    expect(enrollments.count).to eq 5
+    expect(enrollment.id).to eq 1035
   end
 
-  xit 'update the enrollment' do
-    enrollment = Edools::Core::Enrollment.find(1249)
-    enrollment.phone = Time.now.to_i.to_s
+  it 'update the enrollment' do
+    enrollment = Edools::Core::Enrollment.find(1035)
+    enrollment.status = 'expired'
 
-    expect(enrollment.save).to be_true
+    expect(enrollment.save).to eq true
   end
 
-  xit 'create the enrollment' 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()
 
-    expect(enrollment.save).to be_true
-  end
+    enrollment.registration_id = student.registrations.first.id
+    enrollment.school_class_id = school_class.id
+    enrollment.unlimited = true
+    enrollment.status = 'active'
 
-  xit 'destroy the enrollment' do
-    enrollment = Edools::Core::Enrollment.find(1249)
-    expect(enrollment.destroy).to be_true
+    expect(enrollment.save).to eq true
   end
 end

data/spec/edools/core/school_class_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Edools::Core::SchoolClass, :vcr do
+  it 'finds all school class' do
+    school_classs = Edools::Core::SchoolClass.all(params: { school_product_id: 156 })
+
+    expect(school_classs.count).to eq 3
+  end
+
+  it 'finds the school class' do
+    school_class = Edools::Core::SchoolClass.find(168)
+
+    expect(school_class.id).to eq 168
+  end
+
+  it 'update the school class' do
+    school_class = Edools::Core::SchoolClass.find(168)
+    school_class.description = "test description"
+
+    expect(school_class.save).to eq true
+  end
+
+  it 'create the school class' do
+    school_class = Edools::Core::SchoolClass.new()
+    school_class.prefix_options[:school_product_id] = 156
+    school_class.title = 'teste'
+
+    expect(school_class.save).to eq true
+  end
+
+  it 'destroy the school class' do
+    school_class = Edools::Core::SchoolClass.find(168)
+    expect(school_class.destroy.code).to eq '204'
+  end
+end

data/spec/edools/core/school_product_spec.rb

@@ -1,33 +1,35 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Edools::Core::SchoolProduct, :vcr do
-  xit 'finds the school product' do
-    schoolproduct = Edools::Core::SchoolProduct.find(1249)
+  it 'finds all school product' do
+    school_products = Edools::Core::SchoolProduct.all(params: { school_id: 224 })
 
-    expect(schoolproduct.id).to eq 1249
+    expect(school_products.count).to eq 8
   end
 
-  xit 'finds all school product' do
-    schoolproducts = Edools::Core::SchoolProduct.all
+  it 'finds the school product' do
+    school_product = Edools::Core::SchoolProduct.find(170)
 
-    expect(schoolproducts.count).to eq 5
+    expect(school_product.id).to eq 170
   end
 
-  xit 'update the school product' do
-    schoolproduct = Edools::Core::SchoolProduct.find(1249)
-    schoolproduct.phone = Time.now.to_i.to_s
+  it 'update the school product' do
+    school_product = Edools::Core::SchoolProduct.find(170)
+    school_product.description = "test description"
 
-    expect(schoolproduct.save).to be_true
+    expect(school_product.save).to eq true
   end
 
-  xit 'create the school product' do
-    schoolproduct = Edools::Core::SchoolProduct.new()
+  it 'create the school product' do
+    school_product = Edools::Core::SchoolProduct.new()
+    school_product.prefix_options[:school_id] = 224
+    school_product.title = 'teste'
 
-    expect(schoolproduct.save).to be_true
+    expect(school_product.save).to eq true
   end
 
-  xit 'destroy the school product' do
-    schoolproduct = Edools::Core::Schoolproduct.find(1249)
-    expect(schoolproduct.destroy).to be_true
+  it 'destroy the school product' do
+    school_product = Edools::Core::SchoolProduct.find(170)
+    expect(school_product.destroy.code).to eq '204'
   end
 end

data/spec/edools/core/school_spec.rb

@@ -1,32 +1,37 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Edools::Core::School, :vcr do
-  xit 'finds the school' do
-    school = Edools::Core::School.find(1249)
+  it 'finds all school' do
+    schools = Edools::Core::School.all
 
-    expect(school.id).to eq 1249
+    expect(schools.count).to eq 1
   end
 
-  xit 'finds all school' do
-    schools = Edools::Core::School.all
+  it 'finds the school' do
+    school = Edools::Core::School.find(224)
 
-    expect(schools.count).to eq 5
+    expect(school.id).to eq 224
   end
 
-  xit 'update the school' do
-    school = Edools::Core::School.find(1249)
-    school.phone = Time.now.to_i.to_s
+  it 'update the school' do
+    school = Edools::Core::School.find(224)
+    school.phone = "12345678"
 
-    expect(school.save).to be_true
+    expect(school.save).to eq true
   end
 
-  xit 'create the school' do
+  it 'create the school' do
+    pending 'should use an ApiKey with Organization as realm'
     school = Edools::Core::School.new()
+    school.name = "Teste"
+    school.subdomain = "teste"
+    school.status = "trial"
 
-    expect(school.save).to be_true
+    expect(school.save).to eq true
   end
 
   xit 'destroy the school' do
+    pending 'should use an ApiKey with Organization as realm'
     school = Edools::Core::School.find(1249)
     expect(school.destroy).to be_true
   end