edools-api 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86903257522deff62669c3371ed6fdef3bb9a265
-  data.tar.gz: 7867db26712ffba5489941d23d0b1c9d17597bbb
+  metadata.gz: 5bbb880383cb3b397916a8aedec09dbc0b9d92e6
+  data.tar.gz: 5b1562b36c5e71138161a6f353f5f6ce1f85ddef
 SHA512:
-  metadata.gz: 294899fbc52a73f6f76b70039796b187e574ac5b39bcbf541af84c41e8d83e01c68da92e149991081accb39fc1fd82faabd6dcce06bad120ea5fa2c32b331571
-  data.tar.gz: 7bff5c7ba5df04db7fb45b9fff0334818a2419d026e6a91b03c27eb6b8d6da196a3deb97d0a7b4d42aa1993f2a14c5529a7ff57613c1f56af7627f1245770827
+  metadata.gz: 4a97e93a67f8ee6392be4c0c5551ff00308b3996ec2f00e023b3931fa23a31e9013593b96fb4eebaefa5b9629673e30b56ff65cc7fc14f5f0b0468da964cec7d
+  data.tar.gz: ecfd07d91c00cdc15e1507f79865537396808a58a0708586ba96369287d417c721c87912615cda52af1429e3b50677bf35a613b092ecfa141dfd389166127f5b

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/edools-api.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: edools-api 0.4.0 ruby lib
+# stub: edools-api 0.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "edools-api"
-  s.version = "0.4.0"
+  s.version = "0.5.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-09-04"
+  s.date = "2015-07-07"
   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 = [
@@ -29,44 +29,85 @@ Gem::Specification.new do |s|
     "VERSION",
     "edools-api.gemspec",
     "lib/edools.rb",
+    "lib/edools/base.rb",
     "lib/edools/config.rb",
     "lib/edools/core.rb",
     "lib/edools/core/api_key.rb",
     "lib/edools/core/base.rb",
+    "lib/edools/core/course.rb",
+    "lib/edools/core/course_content.rb",
+    "lib/edools/core/course_module.rb",
     "lib/edools/core/enrollment.rb",
+    "lib/edools/core/lesson.rb",
+    "lib/edools/core/media.rb",
     "lib/edools/core/organization.rb",
-    "lib/edools/core/paginated_collection.rb",
+    "lib/edools/core/path.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/session.rb",
     "lib/edools/core/student.rb",
+    "lib/edools/ecommerce.rb",
+    "lib/edools/ecommerce/base.rb",
+    "lib/edools/ecommerce/product.rb",
     "lib/edools/initialization.rb",
+    "lib/edools/paginated_collection.rb",
     "spec/edools/core/api_key_spec.rb",
     "spec/edools/core/base_spec.rb",
+    "spec/edools/core/course_content_spec.rb",
+    "spec/edools/core/course_module_spec.rb",
+    "spec/edools/core/course_spec.rb",
     "spec/edools/core/enrollment_spec.rb",
+    "spec/edools/core/lesson_spec.rb",
+    "spec/edools/core/media_spec.rb",
     "spec/edools/core/organization_spec.rb",
+    "spec/edools/core/path_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/session_spec.rb",
     "spec/edools/core/student_spec.rb",
+    "spec/edools/ecommerce/base_spec.rb",
+    "spec/edools/ecommerce/product_spec.rb",
     "spec/fixtures/vcr_cassettes/Edools_Core_ApiKey/finds_the_api_key.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Course/create_the_course.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Course/destroy_the_course.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Course/finds_all_course.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Course/finds_the_course.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Course/update_the_course.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_CourseContent/create_the_course_content.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_CourseContent/destroy_the_course_content.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_CourseContent/finds_all_course_content.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_CourseContent/finds_the_course_content.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_CourseContent/update_the_course_content.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_CourseModule/create_the_course_module.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_CourseModule/destroy_the_course_module.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_CourseModule/finds_all_course_module.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_CourseModule/finds_the_course_module.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_CourseModule/update_the_course_module.yml",
     "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_Lesson/create_the_lesson.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Lesson/destroy_the_lesson.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Lesson/finds_all_lesson.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Lesson/finds_the_lesson.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Lesson/update_the_lesson.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Media/create_the_media.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Media/destroy_the_media.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Media/finds_all_media.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Media/finds_the_media.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Media/update_the_media.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Path/create_the_path.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Path/destroy_the_path.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Path/finds_all_path.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Path/finds_the_path.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Core_Path/update_the_path.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",
@@ -78,6 +119,11 @@ Gem::Specification.new do |s|
     "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/fixtures/vcr_cassettes/Edools_Ecommerce_Product/create_the_product.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Ecommerce_Product/destroy_the_product.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Ecommerce_Product/finds_all_product.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Ecommerce_Product/finds_the_product.yml",
+    "spec/fixtures/vcr_cassettes/Edools_Ecommerce_Product/update_the_product.yml",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/Edools/edools-api"

data/lib/edools.rb

@@ -1,5 +1,6 @@
 require 'active_resource'
-# require 'kaminari'
 require 'edools/initialization'
 require 'edools/config'
+require 'edools/base'
 require 'edools/core'
+require 'edools/ecommerce'

data/lib/edools/base.rb

@@ -0,0 +1,25 @@
+module Edools
+  class Base < ActiveResource::Base
+    def self.refresh_config!
+      self.format = ActiveResource::Formats::JsonFormat if Edools.format == :json
+      self.format = ActiveResource::Formats::XmlFormat if Edools.format == :xml
+      self.headers['Authorization'] = "Token token=#{Edools.credentials}"
+      self.headers['Accept'] = "application/#{version}+#{Edools.format}"
+    end
+
+    def self.version=(version)
+      @version = version
+    end
+
+    def self.version
+      @version
+    end
+
+    self.site = nil
+    self.version = nil
+    self.include_root_in_json = true
+
+    refresh_config!
+
+  end
+end

data/lib/edools/config.rb

@@ -22,11 +22,11 @@ module Edools
     end
 
     def api_objects
-      ObjectSpace.each_object(Class).select{ |klass| klass < Edools::Core::Base } << Edools::Core::Base
+      ObjectSpace.each_object(Class).select{ |klass| klass < Edools::Base } << Edools::Base
     end
 
     def refresh_config_for_api_objects!
       api_objects.each {|d| d.refresh_config!}
     end
   end
-end
+end

data/lib/edools/core.rb

@@ -1,10 +1,15 @@
 require 'edools/core/base'
 require 'edools/core/api_key'
+require 'edools/core/course'
+require 'edools/core/course_content'
+require 'edools/core/course_module'
 require 'edools/core/enrollment'
+require 'edools/core/lesson'
+require 'edools/core/media'
 require 'edools/core/organization'
+require 'edools/core/path'
 require 'edools/core/registration'
 require 'edools/core/school'
-require 'edools/core/school_class'
 require 'edools/core/school_product'
 require 'edools/core/session'
 require 'edools/core/student'

data/lib/edools/core/base.rb

@@ -1,17 +1,8 @@
 module Edools
   module Core
-    class Base < ActiveResource::Base
+    class Base < Edools::Base
       self.site = Edools::CORE_BASE_URL
-      self.include_root_in_json = true
-
-      def self.refresh_config!
-        self.format = ActiveResource::Formats::JsonFormat if Edools.format == :json
-        self.format = ActiveResource::Formats::XmlFormat if Edools.format == :xml
-        self.headers['Authorization'] = "Token token=#{Edools.credentials}"
-        self.headers['Accept'] = "application/#{Edools::CORE_VERSION}+#{Edools.format}"
-      end
-      refresh_config!
-
+      self.version = Edools::CORE_VERSION
     end
   end
-end
+end

data/lib/edools/core/course.rb

@@ -0,0 +1,10 @@
+require 'edools/core/base'
+require 'edools/paginated_collection'
+
+module Edools
+  module Core
+    class Course < Edools::Core::Base
+      self.collection_parser = Edools::PaginatedCollection
+    end
+  end
+end

data/lib/edools/core/course_content.rb

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

data/lib/edools/core/course_module.rb

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

data/lib/edools/core/enrollment.rb

@@ -1,10 +1,10 @@
 require 'edools/core/base'
-require 'edools/core/paginated_collection'
+require 'edools/paginated_collection'
 
 module Edools
   module Core
     class Enrollment < Edools::Core::Base
-      self.collection_parser = PaginatedCollection
+      self.collection_parser = Edools::PaginatedCollection
 
       def self.collection_path(prefix_options = {}, query_options = nil)
         super

data/lib/edools/core/lesson.rb

@@ -0,0 +1,10 @@
+require 'edools/core/base'
+require 'edools/paginated_collection'
+
+module Edools
+  module Core
+    class Lesson < Edools::Core::Base
+      self.collection_parser = Edools::PaginatedCollection
+    end
+  end
+end

data/lib/edools/core/media.rb

@@ -0,0 +1,10 @@
+require 'edools/core/base'
+require 'edools/paginated_collection'
+
+module Edools
+  module Core
+    class Media < Edools::Core::Base
+      self.collection_parser = Edools::PaginatedCollection
+    end
+  end
+end

data/lib/edools/core/organization.rb

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

data/lib/edools/core/path.rb

@@ -0,0 +1,10 @@
+require 'edools/core/base'
+require 'edools/paginated_collection'
+
+module Edools
+  module Core
+    class Path < Edools::Core::Base
+      self.collection_parser = Edools::PaginatedCollection
+    end
+  end
+end

data/lib/edools/core/registration.rb

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

data/lib/edools/core/school.rb

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

data/lib/edools/core/school_product.rb

@@ -1,10 +1,10 @@
 require 'edools/core/base'
-require 'edools/core/paginated_collection'
+require 'edools/paginated_collection'
 
 module Edools
   module Core
     class SchoolProduct < Edools::Core::Base
-      # self.collection_parser = PaginatedCollection
+      self.collection_parser = Edools::PaginatedCollection
 
       def self.collection_path(prefix_options = {}, query_options = nil)
         super

data/lib/edools/core/session.rb

@@ -1,5 +1,5 @@
 require 'edools/core/base'
-require 'edools/core/paginated_collection'
+require 'edools/paginated_collection'
 
 module Edools
   module Core

data/lib/edools/core/student.rb

@@ -1,11 +1,11 @@
 require 'edools/core/base'
-require 'edools/core/paginated_collection'
+require 'edools/paginated_collection'
 require 'edools/core/enrollment'
 
 module Edools
   module Core
     class Student < Edools::Core::Base
-      self.collection_parser = PaginatedCollection
+      self.collection_parser = Edools::PaginatedCollection
 
       has_many :enrollments, class_name: 'edools/core/enrollment'
 

data/lib/edools/ecommerce.rb

@@ -0,0 +1,2 @@
+require 'edools/ecommerce/base'
+require 'edools/ecommerce/product'

data/lib/edools/ecommerce/base.rb

@@ -0,0 +1,8 @@
+module Edools
+  module Ecommerce
+    class Base < Edools::Base
+      self.site = Edools::ECOMMERCE_BASE_URL
+      self.version = Edools::ECOMMERCE_VERSION
+    end
+  end
+end

data/lib/edools/ecommerce/product.rb

@@ -0,0 +1,21 @@
+require 'edools/ecommerce/base'
+require 'edools/paginated_collection'
+
+module Edools
+  module Ecommerce
+    class Product < Edools::Ecommerce::Base
+      self.collection_parser = Edools::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
+      
+      def to_param
+        self.guid
+      end
+    end
+
+  end
+end

data/lib/edools/initialization.rb

@@ -4,6 +4,9 @@ module Edools
   CORE_BASE_URL = 'https://core.edools.com'
   CORE_VERSION = 'vnd.edools.core.v1'
 
+  ECOMMERCE_BASE_URL = 'https://ecommerce.edools.com'
+  ECOMMERCE_VERSION = 'vnd.edools.ecommerce.v1'
+
   @@credentials = nil
   @@format = :json
-end
+end