smarteru 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 811c7b26440c9f22c4b5d41f6ec6a460e361d75d
+  data.tar.gz: 548cbb83653d4cee166a5ca60050b12fc4a065c6
+SHA512:
+  metadata.gz: a5f2c67db38f87430695c4df2181f4661ddf56ee62dcb35263e44b466465377606058ce4974559730de273c3209b10cf349ed2e90208f971201aadbfa8fe29c1
+  data.tar.gz: 6581fb66f399816bf60e23a88696b3737c2d37122658c0ce18c04d9a47700365ea9e789a666f46d673766ffbe8980cef6e5d03de62eb22210bea9781d1beb42d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Eyecuelab
+
+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,46 @@
+# SmarterU API wrapper
+
+Ruby wrapper for a SmarterU API.
+Allows access to a Smarteru API operations: [api documentation](http://help.smarteru.com/)
+
+
+## Basic Usage
+
+API wrapper can be used from the command line or as part of a Ruby web framework. First install the gem:
+
+    gem install smarteru
+
+Instantiate a client with your SmarterU credentials. You can get it [here](http://smarteru.com/)
+
+    require 'smarteru'
+    client = Smarteru::Client.new(account_api_key: "ACCOUNT_API_KEY", user_api_key: "USER_API_KEY")
+
+Make api calls. You can find a list of API endpoints [here](http://help.smarteru.com/)
+
+    response = client.request('getGroup', {group: {name: 'MyGroup'}})
+    response.result =>
+      {
+        group: {
+          name: "MyGroup",
+          group_id: nil,
+          created_date: "2015-01-22 23:42:55.553",
+          modified_date: "2015-01-23 01:25:02.013",
+          description: {
+            p: "Group Description ..."
+          },
+          home_group_message: {
+            p: "Welcome to The Group"
+          },
+          notification_emails: nil,
+          user_count: "2",
+          learning_module_count: "2",
+          tags: nil,
+          status: "Active"
+        }
+      }
+
+
+## Testing
+
+    bundle install
+    rake

data/Rakefile

@@ -0,0 +1,21 @@
+# 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 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/lib/smarteru.rb

@@ -0,0 +1,11 @@
+require 'rest-client'
+require 'libxml'
+require 'xmlhasher'
+
+require 'smarteru/client'
+require 'smarteru/response'
+
+module Smarteru
+  API_HOST = 'api.smarteru.com'
+  API_VERSION = "apiv2"
+end

data/lib/smarteru/client.rb

@@ -0,0 +1,98 @@
+module Smarteru
+  class Client
+    attr_reader :account_api_key, :user_api_key,
+                :use_ssl, :verify_ssl, :ssl_ca_file,
+                :api_url
+
+    # Create an instance of an API client
+    #
+    # ==== Attributes
+    # * +options+ - Access credentials and options hash, required keys are: account_api_key, user_api_key
+    # ==== Example
+    # client = Smarteru::Client.new({account_api_key: 'abc', user_api_key: 'abc'})
+    def initialize options = {}
+      @account_api_key = options[:account_api_key]
+      @user_api_key = options[:user_api_key]
+      @use_ssl = options[:use_ssl] || true
+      @verify_ssl = options[:verify_ssl]
+      @ssl_ca_file = options[:ssl_ca_file]
+      @api_url = "#{use_ssl ? 'https' : 'http'}://#{API_HOST}/#{API_VERSION}/"
+    end
+
+    # Make an API request
+    #
+    # ==== Attributes
+    # * +operation+  - Operation method eg getGroup
+    # * +data+ - Data hash
+    # ==== Example
+    # client.request("getGroup", {
+    #   group: {
+    #     name: 'MyGroup'
+    #   }
+    # })
+    def request(operation, data)
+      opts = {
+        method: :post,
+        url: api_url,
+        payload: {'Package' => body(operation, data)},
+        content_type: :xml,
+        verify_ssl: verify_ssl,
+        ssl_ca_file: ssl_ca_file
+      }
+      Response.new(RestClient::Request.execute(opts))
+    end
+
+    private
+
+    # Build xml request body
+    #
+    # ==== Attributes
+    # * +operation+ - Operation method
+    # * +parameters+ - Parameters hash
+    # ==== Example
+    # client.body("createUser", {email: 'email@example.com', ...})
+    def body(operation, param_data)
+      %{<?xml version="1.0" encoding="UTF-8"?>
+        <SmarterU>
+        <AccountAPI>#{account_api_key}</AccountAPI>
+        <UserAPI>#{user_api_key}</UserAPI>
+        <Method>#{operation}</Method>
+        <Parameters>#{body_parameters(param_data)}</Parameters>
+        </SmarterU>}
+    end
+
+    # Build body parameteres xml
+    #
+    # ==== Attributes
+    # * +parameters+ - Parameters hash
+    def body_parameters(parameters)
+      parameters_xml = ''
+      parameters.each_pair do |k,v|
+        key = parameter_key(k)
+
+        case v
+        when Hash
+          val = body_parameters(v)
+        when Array
+          val = v.map {|i| body_parameters(i) }.join('')
+        else
+          val = "<![CDATA[#{v}]]>"
+        end
+
+        parameters_xml << "<#{key}>#{val}</#{key}>"
+      end
+      parameters_xml
+    end
+
+    # Prepare parameter key
+    #
+    # ==== Attributes
+    # * +parameters+ - Parameters hash
+    def parameter_key(term)
+      string = term.to_s
+      string = string.sub(/^[a-z\d]*/) { $&.capitalize }
+      string.gsub!(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }
+      string
+    end
+  end
+end

data/lib/smarteru/response.rb

@@ -0,0 +1,39 @@
+module Smarteru
+  class Response
+    attr_reader :data, :hash, :parser
+
+    # Initializes an API response
+    #
+    # ==== Attributes
+    # * +resp+ - RestClient response from the API
+    def initialize(res)
+      @data = res
+      @parser = XmlHasher::Parser.new(
+        snakecase: true,
+        ignore_namespaces: true,
+        string_keys: false
+      )
+    end
+
+    # Hash representation of response data
+    def to_hash
+      return @hash if @hash
+      @hash = parser.parse(data.to_s.gsub(/\<!\[CDATA\[(.+)\]\]\>/) {$1})
+    end
+
+    # Return true/false based on the API response status
+    def success?
+      to_hash[:smarter_u][:result] == 'Success'
+    rescue
+      false
+    end
+
+    def result
+      to_hash[:smarter_u][:info]
+    end
+
+    def error
+      to_hash[:smarter_u][:errors]
+    end
+  end
+end

data/lib/smarteru/version.rb

@@ -0,0 +1,3 @@
+module Smarteru
+  VERSION = '0.0.1'
+end

data/test/helper.rb

@@ -0,0 +1,29 @@
+require 'test/unit'
+require 'webmock/test_unit'
+
+require 'smarteru'
+
+class Test::Unit::TestCase
+  ACCESS_CREDENTIALS = {
+    account_api_key: "abc",
+    user_api_key: "abc"
+  }
+
+  def stub_v2_api_call(operation, payload_package_xml)
+    filename = "#{operation}.xml"
+    stub_request(:post, 'https://api.smarteru.com/apiv2/')
+    .with(:body => {"Package"=>"#{payload_package_xml}"})
+    .to_return(
+      body: expected_body(filename),
+      status: 200
+    )
+  end
+
+  def request_payload(filename)
+    File.read(File.join(File.dirname(__FILE__), 'support/requests/' << filename))
+  end
+
+  def expected_body(filename)
+    File.read(File.join(File.dirname(__FILE__), 'support/responses/' << filename))
+  end
+end

data/test/smarteru_test.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+class TestSmarteru < Test::Unit::TestCase
+
+  def setup
+    @client = Smarteru::Client.new(ACCESS_CREDENTIALS)
+  end
+
+  def test_request_get_group
+    stub_request = stub_v2_api_call('getGroup', request_payload('getGroup.xml'))
+    response = @client.request('getGroup', {group: {name: 'MyGroup'}})
+    assert_equal(response.data, expected_body('getGroup.xml'))
+    assert_requested(stub_request)
+  end
+
+  def test_response_result_hash
+    stub_request = stub_v2_api_call('getGroup', request_payload('getGroup.xml'))
+    response = @client.request('getGroup', {group: {name: 'MyGroup'}})
+    assert_equal(response.result, {
+      group: {
+        name: "MyGroup",
+        group_id: nil,
+        created_date: "2015-01-22 23:42:55.553",
+        modified_date: "2015-01-23 01:25:02.013",
+        description: {
+          p: "Group Description ..."
+        },
+        home_group_message: {
+          p: "Welcome to The Group"
+        },
+        notification_emails: nil,
+        user_count: "2",
+        learning_module_count: "2",
+        tags: nil,
+        status: "Active"
+      }
+    })
+  end
+
+  def test_response_success_method
+    stub_request = stub_v2_api_call('getGroup', request_payload('getGroup.xml'))
+    response = @client.request('getGroup', {group: {name: 'MyGroup'}})
+    assert_equal(true, response.success?)
+  end
+end

data/test/support/requests/getGroup.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+        <SmarterU>
+        <AccountAPI>abc</AccountAPI>
+        <UserAPI>abc</UserAPI>
+        <Method>getGroup</Method>
+        <Parameters><Group><Name><![CDATA[MyGroup]]></Name></Group></Parameters>
+        </SmarterU>

data/test/support/responses/getGroup.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SmarterU>
+					<Result>Success</Result>
+					<Info>
+				<Group>
+					<Name><![CDATA[MyGroup]]></Name>
+					<GroupID/>
+					<Created_Date><![CDATA[2015-01-22 23:42:55.553]]></Created_Date>
+					<Modified_Date><![CDATA[2015-01-23 01:25:02.013]]></Modified_Date>
+					<Description><![CDATA[<p>Group Description ...</p>]]></Description>
+					<HomeGroupMessage><![CDATA[<p>Welcome to The Group</p>]]></HomeGroupMessage>
+					<NotificationEmails>
+						
+					</NotificationEmails>
+					<UserCount>2</UserCount>
+					<LearningModuleCount>2</LearningModuleCount>
+					<Tags>
+						
+					</Tags>
+					<Status><![CDATA[Active]]></Status>
+				</Group>
+			</Info>
+					<Errors>
+						
+					</Errors>
+				</SmarterU>

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: smarteru
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sasha Shamne
+- EyecueLab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: xmlhasher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Ruby wrapper for Smarteru API
+email:
+- alexander.shamne@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/smarteru.rb
+- lib/smarteru/client.rb
+- lib/smarteru/response.rb
+- lib/smarteru/version.rb
+- test/helper.rb
+- test/smarteru_test.rb
+- test/support/requests/getGroup.xml
+- test/support/responses/getGroup.xml
+homepage: http://github.com/eyecuelab/smarteru
+licenses:
+- MIT
+metadata: {}
+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.4
+signing_key: 
+specification_version: 4
+summary: Allows access to a Smarteru API operations http://help.smarteru.com/
+test_files:
+- test/helper.rb
+- test/smarteru_test.rb
+- test/support/requests/getGroup.xml
+- test/support/responses/getGroup.xml