edools-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3eade3c23eee728077692f503d70ba857c08046
+  data.tar.gz: 5091623e13c4f66a376c337444a29e92ff01798f
+SHA512:
+  metadata.gz: 554440efb0345b30a1374dc8df8e6f4ec24b292d2dfd8c5c6fff7fec4a62531c8377da9162a10d458919f1858b401d408fe3a6d7109718ed735882c548881ccf
+  data.tar.gz: d9d1bdf18515517ba422e2fa5c54481525bb92299d7207a4366623af9ea22c75fedb784ba9f7a7e284f0fa1b818c61166ca120422b60d9845526def719b84b70

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+
+gem 'activeresource', '>= 4.0.0'
+# gem 'kaminari', '>= 0.16.0'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rspec', "~> 3.0.0"
+  gem 'vcr', "~> 2.9.2"
+  gem 'webmock', "~> 1.18.0"
+  gem 'pry', "~> 0.10.0"
+  gem "yard", "~> 0.7"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,116 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (4.1.4)
+      activesupport (= 4.1.4)
+      builder (~> 3.1)
+    activeresource (4.0.0)
+      activemodel (~> 4.0)
+      activesupport (~> 4.0)
+      rails-observers (~> 0.1.1)
+    activesupport (4.1.4)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    builder (3.2.2)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.7)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (3.2.0)
+    highline (1.6.21)
+    i18n (0.6.11)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.0.0)
+    method_source (0.8.2)
+    mini_portile (0.6.0)
+    minitest (5.4.0)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rails-observers (0.1.2)
+      activemodel (~> 4.0)
+    rake (10.3.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.3)
+    safe_yaml (1.0.3)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+    vcr (2.9.2)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+    yard (0.8.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activeresource (>= 4.0.0)
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  pry (~> 0.10.0)
+  rdoc (~> 3.12)
+  rspec (~> 3.0.0)
+  simplecov
+  vcr (~> 2.9.2)
+  webmock (~> 1.18.0)
+  yard (~> 0.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Vinicius Kastrup
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,19 @@
+= edools-api
+
+Description goes here.
+
+== Contributing to edools-api
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Vinicius Kastrup. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "edools-api"
+  gem.homepage = "http://github.com/Edools/edools-api"
+  gem.license = "MIT"
+  gem.summary = %Q{This gem is a Ruby wrapper for all Edools API's}
+  gem.description = %Q{
+    With this gem you'll be able to access and manipulate all the data of your School or Organization
+    hosted at Edools.
+  }
+  gem.email = "viniciusmkm@gmail.com"
+  gem.authors = ["Vinicius Kastrup"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/edools.rb

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

data/lib/edools/config.rb

@@ -0,0 +1,32 @@
+require 'edools/initialization'
+
+module Edools
+  class << self
+    attr_accessor :credentials, :format
+
+    # Set your API credentials using this method.
+    def credentials= (new_credentials)
+      @credentials = new_credentials
+      refresh_config_for_api_objects!
+      @credentials
+    end
+
+    # Set the format that the API uses to either 'json' or 'xml'.
+    # Accepts either a String or a Symbol.
+    def format=(new_format)
+      valid_formats = [:json, :xml]
+      raise ArgumentError, "Invalid format.  Supported formats: #{valid_formats.join(', ')}." unless valid_formats.include?(new_format.to_sym)
+      @format = new_format
+      refresh_config_for_api_objects!
+      @format
+    end
+
+    def api_objects
+      ObjectSpace.each_object(Class).select{ |klass| klass < Edools::Core::Base } << Edools::Core::Base
+    end
+
+    def refresh_config_for_api_objects!
+      api_objects.each {|d| d.refresh_config!}
+    end
+  end
+end

data/lib/edools/core.rb

@@ -0,0 +1,7 @@
+require 'edools/core/base'
+require 'edools/core/enrollment'
+require 'edools/core/organization'
+require 'edools/core/registration'
+require 'edools/core/school'
+require 'edools/core/school_product'
+require 'edools/core/student'

data/lib/edools/core/base.rb

@@ -0,0 +1,17 @@
+module Edools
+  module Core
+    class Base < ActiveResource::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!
+
+    end
+  end
+end

data/lib/edools/core/enrollment.rb

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

data/lib/edools/core/organization.rb

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

data/lib/edools/core/paginated_collection.rb

@@ -0,0 +1,30 @@
+require 'active_resource'
+
+module Edools
+  module Core
+    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)
+        (ObjectSpace.each_object(Class)
+          .select{ |klass| klass < Edools::Core::Base }
+          .collect { |klass| klass.name.split("::").last.downcase.pluralize } & keys).first
+      end
+
+    end
+  end
+end

data/lib/edools/core/registration.rb

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

data/lib/edools/core/school.rb

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

data/lib/edools/core/school_product.rb

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

data/lib/edools/core/student.rb

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

data/lib/edools/initialization.rb

@@ -0,0 +1,9 @@
+require 'active_resource'
+
+module Edools
+  CORE_BASE_URL = 'https://core.edools.com'
+  CORE_VERSION = 'vnd.edools.core.v1'
+
+  @@credentials = nil
+  @@format = :json
+end

data/spec/edools/core/base_spec.rb

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