gensee 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 629ab6dea129507b506155bfb1817682beb048ae
+  data.tar.gz: 7274e69ae6b15227f75396e1eec1d3f25097e384
+SHA512:
+  metadata.gz: 81ed3069aab3d3787c2520ebdb716f131c4afecde94a7a585b22e04a7e57fe1dc6cbbd1c43b97cdc5eff8a2a40ddcf90586bd715aa7dfbfe65cf9eb3efd7c833
+  data.tar.gz: 88dc378c2719a0c9bfdf80671e23669af6340b2a0651ca18f2040f01f19bce9d7c85e6311e3fc6bcca9ad53fed13377da29a461aa45b2a62657bce9071e5285a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gensee.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yuan He
+
+MIT License
+
+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,63 @@
+# Gensee
+
+Gensee is Ruby wrapper for [Gensee API](http://www.gensee.com/document-technical.php),
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gensee'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gensee
+
+## Usage
+
+```ruby
+# Provide authentication credentials
+Gensee.configure do |c|
+  c.endpoint = 'http://yoursubdomain.gensee.com'
+  c.login = 'loginname'
+  c.password = 'yourpassword'
+end
+
+# Create classroom
+classroom = Gensee.client.create_classroom('AWESOME CLASSROOM', Time.now, rand(100_000..200_000), rand(100_000..2000_000))
+puts classroom[:student_join_url] # http://youdomain.gensee.com/training/site/s/{classroom_number}
+puts classroom[:teacher_join_url] # http://youdomain.gensee.com/training/site/s/{classroom_number}
+puts classroom[:number] # 34154643
+puts classroom[:id] # mquQf2
+```
+
+or
+
+```ruby
+# Provide authentication credentials
+client = Gensee::Client.new(endpoint: 'http://yoursubdomain.gensee.com', login: 'gensee@username', password: 'yourpassword')
+# create classroom
+classroom = client.create_classroom('AWESOME CLASSROOM', Time.now, rand(100_000..200_000), rand(100_000..2000_000))
+puts classroom[:student_join_url] # http://youdomain.gensee.com/training/site/s/{classroom_number}
+puts classroom[:teacher_join_url] # http://youdomain.gensee.com/training/site/s/{classroom_number}
+puts classroom[:number] # 34154643
+puts classroom[:id] # mquQf2
+```
+
+## Testing
+
+    $export GENSEE_ENDPOINT='http://yoursubdomain.gensee.com' GENSEE_LOGIN=loginname GENSEE_PASSWORD=somelooogpassword
+    $ rake
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/gensee/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/gensee.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gensee/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gensee'
+  spec.version       = Gensee::VERSION
+  spec.authors       = ['Yuan He']
+  spec.email         = ['yuan@liulishuo.com']
+  spec.summary       = %q{A Gensee API Wrapper in Ruby}
+  spec.description   = %q{Using Gensee JSON API easily}
+  spec.homepage      = 'https://git.llsapp.com/yuan/gensee/tree/master'
+  spec.license       = 'MIT'
+
+  spec.add_runtime_dependency 'faraday', '~> 0.9'
+  spec.add_runtime_dependency 'oj', '~> 2.11'
+  spec.add_runtime_dependency 'activesupport', '~> 3.1'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

data/lib/gensee.rb

@@ -0,0 +1,15 @@
+require 'gensee/version'
+require 'gensee/client'
+
+module Gensee
+
+  class << self
+    include Gensee::Configurable
+
+    # @return [Gensee::Client] Gensee API Wrapper client
+    def client
+      @client = Gensee::Client.new(options)
+      @client
+    end
+  end
+end

data/lib/gensee/client.rb

@@ -0,0 +1,75 @@
+require 'faraday'
+require 'digest'
+require 'oj'
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/hash'
+require 'gensee/client/training'
+require 'gensee/configurable'
+
+module Gensee
+  # Client for Gensee API
+  #
+  # @see http://www.gensee.com/document-technical.php
+  # @params: uri [String], the URI/endpoint which Gensee created for you
+  #          username [String], Your Gensee login in name. might be an email address
+  #          password [String], Your Gensee password
+  class Client
+    include Gensee::Client::Training
+
+    def initialize(options = {})
+      opts = options.dup
+      @endpoint = opts[:endpoint].start_with?('http://') ? opts[:endpoint] : "http://#{opts[:endpoint]}"
+      @username = opts[:login]
+      @password = Digest::MD5.hexdigest(opts[:password])
+    end
+
+    def default_options
+      { loginName: @username, password: @password, sec: 'true' }
+    end
+
+    def app_client
+      @client ||= Faraday.new(@endpoint) do |conn|
+        conn.params = default_options
+        conn.headers = {
+          content_type: 'application/json',
+          user_agent: Gensee::Configurable.user_agent
+        }
+        conn.request :url_encoded
+        # conn.response :logger
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    private
+
+    def request(method, path, params)
+      resp = app_client.send(method, path, params)
+      convert_result(resp)
+    end
+
+    %w(get post).each do |m|
+      define_method m do |path, params|
+        request(m, path, params)
+      end
+    end
+
+    ## Helper methods
+    def preform_path(path)
+      "/integration/site/#{path}"
+    end
+
+    def time_to_ms(time)
+      (time.to_f * 1000).to_i
+    end
+
+    def convert_result(resp)
+      if resp.success?
+        h = Oj.load(resp.body)
+        ary = h.inject([]) { |r, (k, v)| r << [k.to_s.underscore, v] }
+        Hash[ary].with_indifferent_access
+      else
+        resp
+      end
+    end
+  end
+end

data/lib/gensee/client/training.rb

@@ -0,0 +1,75 @@
+module Gensee
+  class Client
+    # Gensee Training API
+    # @see http://www.gensee.com/document-technical.php
+    module Training
+      ##-------------------- CLASSROOM --------------------##
+      # Create an Training classroom
+      # @params: subject [String] *required*: classroom name/subject
+      #          start_date [DateTime] *required*: Time which classroom will open.
+      #          teacher_token [String/Integer] *required*: teacher token to login classroom(length: 6~15)
+      #          assistant_token [String/Integer] *required*: assistant token to login classroom
+      # @notice  subject is an unique field
+      #          teacher_token and assistant_token should NOT be same value
+      def create_classroom(subject, start_date, teacher_token, assistant_token, options = {})
+        params = options.dup
+        params[:subject] = subject
+        params[:startDate] = time_to_ms(start_date)
+        params.merge!(teacherToken: teacher_token.to_s, assistantToken: assistant_token.to_s)
+        get preform_path('training/room/created'), params
+      end
+
+      # Modify Training classroom info
+      # @params: id [String] *required*: classroom id
+      def modify_classroom(id, subject, start_date, teacher_token, assistant_token, options = {})
+        params = options.dup
+        params[:id] = id
+        params[:subject] = subject
+        params[:startDate] = time_to_ms(start_date)
+        params.merge!(teacherToken: teacher_token.to_s, assistantToken: assistant_token.to_s)
+        get preform_path('training/room/modify'), params
+      end
+
+      def delete_classroom(room_id)
+        get preform_path('training/room/deleted'), roomId: room_id
+      end
+
+      def classroom_info(room_id)
+        get preform_path('training/room/info'), roomId: room_id
+      end
+
+      ##-------------------- COURSEWARE --------------------##
+
+      # List all classrooms courseware
+      def courseware_list(room_id)
+        get preform_path('training/courseware/list'), roomId: room_id
+      end
+
+      def courseware_info(id)
+        get preform_path('training/courseware/info'), coursewareId: id
+      end
+
+      # Modify courseware
+      # @params id [String]: courseware ID
+      def modify_courseware(id, subject, options = {})
+        params= options.dup
+        get preform_path('training/courseware/modify'), params.merge!(id: id, subject: subject)
+      end
+
+      def delete_courseware(id)
+        get preform_path('training/courseware/deleted'), coursewareId: id
+      end
+
+      ##-------------------- TEACHER --------------------##
+
+      # Register a teacher
+      # @params login [String]: teacher login name(email/mobile) (length: 1~40)
+      #         password [String]: teacher login password (length: 6~15)
+      #         name [String]: teacher name, (length: 1-40)
+      def create_teacher(name, login, password)
+        params = { name: name, teacherLoginName: login, teacherPassword: password }
+        get preform_path('training/teacher/created'), params
+      end
+    end
+  end
+end

data/lib/gensee/configurable.rb

@@ -0,0 +1,38 @@
+module Gensee
+  module Configurable
+    attr_accessor :endpoint, :login, :password
+
+    class << self
+      USER_AGENT   = "Gensee Ruby Gem #{Gensee::VERSION}".freeze
+      # List all keys
+      # @return [Array]
+      def keys
+        @keys ||= [:endpoint, :login, :password]
+      end
+
+      def default_options
+        {
+          endpoint: ENV['GENSEE_ENDPOINT'],
+          login: ENV['GENSEE_LOGIN'],
+          password: ENV['GENSEE_PASSWORD']
+        }
+      end
+
+      def user_agent
+        ENV['GENSEE_USER_AGENT'] || USER_AGENT
+      end
+    end
+
+    def options
+      ary = Gensee::Configurable.keys.map do |key|
+        [key, send(key) || Gensee::Configurable.default_options[key]]
+      end
+      Hash[ary]
+    end
+
+    # Set configuration options using a block
+    def configure
+      yield self
+    end
+  end
+end

data/lib/gensee/version.rb

@@ -0,0 +1,3 @@
+module Gensee
+  VERSION = "0.1.0"
+end

data/spec/gensee/client/training_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Gensee::Client::Training do
+  ## NOTICE: Below tests need a read Gensee account,
+  ## please set then var ENV, for example:
+  ## export GENSEE_ENDPOINT='http://yoursubdomain.gensee.com' GENSEE_LOGIN='loginname' GENSEE_PASSWORD='somelooogpassword'
+
+  let(:client) { Gensee.client }
+  let(:classroom) { client.create_classroom("[TEST] a funny topic #{rand(100)}", Time.now, rand(100_000..200_000).to_s, rand(100_000..200_000).to_s) }
+  context 'classroom' do
+    after(:each) do
+      expect(client.delete_classroom(classroom[:id])[:code]).to eq '0'
+    end
+
+    it 'create' do
+      expect(classroom).to be_kind_of Hash
+      expect(classroom[:code]).to eq '0'
+    end
+
+    it 'modify and delete' do
+      new_subject = '[Test] NEW classroom subject'
+      t = Time.now + 600 * 60
+      room = client.modify_classroom(classroom[:id], new_subject, t, classroom[:teacher_token], classroom[:assistant_token])
+      expect(room[:code]).to eq '0'
+    end
+
+    it 'query and delete' do
+      info = client.classroom_info(classroom[:id])
+      expect(info[:id]).to eq info[:id]
+    end
+  end
+
+  context 'classware' do
+    it 'should list all' do
+      list = client.courseware_list classroom[:id]
+      expect(list[:code]).to eq '0'
+    end
+  end
+end

data/spec/gensee/client_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Gensee::Client do
+end

data/spec/gensee/configurable_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Gensee::Configurable do
+  let(:uri) { 'http://www.example.com' }
+  let(:login) { 'username' }
+  let(:password) { 'password' }
+
+  it '.configure' do
+    Gensee.configure do |c|
+      c.endpoint = uri
+      c.login = login
+      c.password = password
+    end
+    expect(Gensee.options).to be_kind_of Hash
+  end
+end

data/spec/gensee_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Gensee do
+  let(:uri) { 'http://example.gensee.com' }
+  let(:uri_without_schema) { 'example.gensee.com' }
+
+  context '.client' do
+
+    before(:all) do
+      Gensee.configure do |c|
+        c.endpoint = 'http://example.gensee.com'
+        c.login = 'hello'
+        c.password = 'hello'
+      end
+    end
+
+    it 'should accept as uri without schema' do
+      @client = Gensee.client
+      expect(@client.app_client.build_url.to_s).to match %r{http://}
+    end
+
+    it 'create an Gensee::Client' do
+      expect(Gensee.client).to be_kind_of Gensee::Client
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+Bundler.setup
+require 'gensee'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: gensee
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuan He
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Using Gensee JSON API easily
+email:
+- yuan@liulishuo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gensee.gemspec
+- lib/gensee.rb
+- lib/gensee/client.rb
+- lib/gensee/client/training.rb
+- lib/gensee/configurable.rb
+- lib/gensee/version.rb
+- spec/gensee/client/training_spec.rb
+- spec/gensee/client_spec.rb
+- spec/gensee/configurable_spec.rb
+- spec/gensee_spec.rb
+- spec/spec_helper.rb
+homepage: https://git.llsapp.com/yuan/gensee/tree/master
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Gensee API Wrapper in Ruby
+test_files:
+- spec/gensee/client/training_spec.rb
+- spec/gensee/client_spec.rb
+- spec/gensee/configurable_spec.rb
+- spec/gensee_spec.rb
+- spec/spec_helper.rb
+has_rdoc: