moodle-api 1.2

data/lib/moodle.rb

@@ -0,0 +1 @@
+require 'moodle/api'

data/lib/moodle/api.rb

@@ -0,0 +1,34 @@
+require 'moodle/api/version'
+require 'moodle/api/configuration'
+require 'moodle/api/client'
+require 'moodle/api/errors'
+require 'moodle/api/token_generator'
+require 'moodle/api/request'
+
+begin
+  require 'pry'
+rescue
+  LoadError
+end
+
+module Moodle
+  module Api
+    class << self
+      def method_missing method, *args, &block
+        if client.respond_to?(method)
+          client.send(method, *args, &block)
+        else
+          client.make_request(method, args.first) # assume method name is moodle external service
+        end
+      end
+
+      def respond_to?(method, include_all=false)
+        return client.respond_to?(method, include_all) || super
+      end
+
+      def client
+        @client ||= Moodle::Api::Client.new
+      end
+    end
+  end
+end

data/lib/moodle/api/client.rb

@@ -0,0 +1,40 @@
+module Moodle
+  module Api
+    class Client
+      attr_reader :web_service_name, :filter_params
+      attr_writer :token_service
+
+      def initialize options = {}
+        configure(options)
+      end
+
+      def make_request web_service_name, filter_params = {}
+        @web_service_name = web_service_name
+        @filter_params = filter_params
+
+        Request.new.post(configuration.web_service_api_url, request_params)
+      end
+
+      def request_params
+        {
+          params: filter_params.merge!({ moodlewsrestformat: configuration.format,
+                                         wsfunction: web_service_name,
+                                         wstoken: configuration.token }),
+          headers: { 'Accept' => 'json' }
+        }
+      end
+
+      def configure options = {}, &block
+        configuration.configure(options, &block)
+      end
+
+      def reset_configuration
+        configuration.reset
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+    end
+  end
+end

data/lib/moodle/api/configuration.rb

@@ -0,0 +1,55 @@
+module Moodle
+  module Api
+    class Configuration
+      attr_writer :token_service
+      attr_accessor :host,
+        :username,
+        :password,
+        :service,
+        :token,
+        :format
+
+      DEFAULT_FORMAT = :json
+
+      DEFAULT_WEB_SERVICE_API_URL = '/webservice/rest/server.php'
+
+      DEFAULT_TOKEN_API_URL = '/login/token.php'
+
+      def initialize options = {}
+        @format = DEFAULT_FORMAT
+
+        configure(options)
+      end
+
+      def reset
+        @host = nil
+        @username = nil
+        @password = nil
+        @service = nil
+        @token = nil
+        @format = DEFAULT_FORMAT
+      end
+
+      def web_service_api_url
+        "#{host}#{DEFAULT_WEB_SERVICE_API_URL}"
+      end
+
+      def token_api_url
+        "#{host}#{DEFAULT_TOKEN_API_URL}"
+      end
+
+      def configure options = {}, &block
+        options.each { |key, value| instance_variable_set("@#{key}", value) }
+        block.call(self) if block_given?
+      end
+
+      def token
+        @token ||= token_service.call # if not set use token service
+      end
+
+      def token_service
+        @token_service ||= TokenGenerator.new(self)
+      end
+    end
+  end
+end

data/lib/moodle/api/errors.rb

@@ -0,0 +1,5 @@
+module Moodle
+  module Api
+    class MoodleError < StandardError; end
+  end
+end

data/lib/moodle/api/request.rb

@@ -0,0 +1,45 @@
+require 'typhoeus'
+require 'json'
+
+module Moodle
+  module Api
+    class Request
+      attr_reader :response
+
+      def post path,  options = {}
+        @response = Typhoeus.post(path, options)
+        resolve_response if response.success?
+      end
+
+      private
+
+      def resolve_response
+        response_body unless request_raised_exception?
+      end
+
+      def request_raised_exception?
+        if external_services_api_exception?
+          raise MoodleError, response_body["message"]
+        elsif token_service_api_exception?
+          raise MoodleError, response_body["error"]
+        end
+      end
+
+      def exception_raised?
+        external_services_api_exception? && token_service_api_exception?
+      end
+
+      def external_services_api_exception?
+        response_body.is_a?(Hash) && response_body['exception']
+      end
+
+      def token_service_api_exception?
+        response_body.is_a?(Hash) && response_body['error']
+      end
+
+      def response_body
+        JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/moodle/api/token_generator.rb

@@ -0,0 +1,37 @@
+module Moodle
+  module Api
+    class TokenGenerator
+      attr_reader :configuration
+
+      def initialize configuration
+        @configuration = configuration
+      end
+
+      def call
+        raise ArgumentError, 'Username and password are required to generate a token' if raise_token_exception?
+        generate_token
+      end
+
+      private
+
+      def generate_token
+        response = Request.new.post(configuration.token_api_url,
+                                    params: request_params,
+                                    headers: { 'Accept' => "json" })
+        response['token']
+      end
+
+      def raise_token_exception?
+        configuration.username.nil? || configuration.password.nil?
+      end
+
+      def request_params
+        {
+          username: configuration.username,
+          password: configuration.password,
+          service: configuration.service
+        }
+      end
+    end
+  end
+end

data/lib/moodle/api/version.rb

@@ -0,0 +1,5 @@
+module Moodle
+  module Api
+    VERSION = "1.2"
+  end
+end

data/moodle-api.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'moodle/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "moodle-api"
+  spec.version       = Moodle::Api::VERSION
+  spec.authors       = ["Ryan-Neal Mes"]
+  spec.email         = ["ryan.mes@gmail.com"]
+
+  spec.summary       = %q{Moodle web service API wrapper.}
+  spec.description   = %q{Wraps Moodle API and exposes web services that have been made external.}
+  spec.homepage      = "https://github.com/get-smarter/moodle-api"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'vcr'
+
+  spec.add_dependency 'typhoeus'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: moodle-api
+version: !ruby/object:Gem::Version
+  version: '1.2'
+platform: ruby
+authors:
+- Ryan-Neal Mes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wraps Moodle API and exposes web services that have been made external.
+email:
+- ryan.mes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fixtures/vcr_cassettes/external_service/invalid_service.yml
+- fixtures/vcr_cassettes/external_service/token_service.yml
+- fixtures/vcr_cassettes/external_service/valid_service.yml
+- fixtures/vcr_cassettes/external_service/valid_service_empty_array_response.yml
+- fixtures/vcr_cassettes/external_service/valid_service_not_external.yml
+- fixtures/vcr_cassettes/external_service/valid_service_with_invalid_token.yml
+- fixtures/vcr_cassettes/token_service/error_invalid_service_token_service.yml
+- fixtures/vcr_cassettes/token_service/invalid_password_token_service.yml
+- fixtures/vcr_cassettes/token_service/invalid_permissions_token_service.yml
+- fixtures/vcr_cassettes/token_service/invalid_service_token_service.yml
+- fixtures/vcr_cassettes/token_service/invalid_user_token_service.yml
+- fixtures/vcr_cassettes/token_service/invalid_username_token_service.yml
+- fixtures/vcr_cassettes/token_service/token_service.yml
+- lib/moodle.rb
+- lib/moodle/api.rb
+- lib/moodle/api/client.rb
+- lib/moodle/api/configuration.rb
+- lib/moodle/api/errors.rb
+- lib/moodle/api/request.rb
+- lib/moodle/api/token_generator.rb
+- lib/moodle/api/version.rb
+- moodle-api.gemspec
+homepage: https://github.com/get-smarter/moodle-api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Moodle web service API wrapper.
+test_files: []