wtforum 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-version
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/support/credentials.rb
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Micah Geisel
+
+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,74 @@
+# WTForum
+
+Ruby library that wraps Website Toolbox's Forum API.
+
+Useful for folks looking to embed the forum into their site, while maintaining
+a user-facing appearance of a single user account.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wtforum'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wtforum
+
+## Features
+
+    WTForum has the following features:
+
+    * CRUD (create, read, update, & delete) user accounts
+      ```ruby
+      # modeled after ActiveRecord API
+      user = WTForum::User.create username: "wtforum_test_user", email: "wtforum_test_user@example.com"
+      user = WTForum::User.find(user.id)
+      user.update_attributes! username: "wtforum_test_user_2", email: "wtforum_test_user_2@example.com"
+      user.destroy
+      ```
+
+    * Log in your user via their Single Sign On (SSO) API
+      ```ruby
+      session = WTForum::Session.create(user.id)
+      session.token # => REiB6U5SkxB
+      ```
+
+## Configuration
+
+    Before using WTForum, you need to give it administrator credentials. It
+    needs four pieces of information:
+    1) Where the forum is hosted.
+    2) The API key that Website Toolbox provides.
+    3) Username of an admin account.
+    4) Password for said admin account.
+
+    Example Rails config:
+    ```ruby
+    # config/initializers/wtforum_credentials.rb
+    WTForum.domain = "forum.example.com"
+    WTForum.api_key = "TEgPYR4Zapz"
+    WTForum.admin_username = "__admin_api_dont_delete__"
+    WTForum.admin_password = "s0m3p4ssw0rd"
+    ```
+
+## Why do we need to specify an admin user account in the credentials?
+
+    Unfortunately, Website Toolbox's Forum API is missing some functionality.
+    Specifically, you can only create a new forum user account. Need to read,
+    update, or delete an existing user via the API? You're out of luck! As a
+    workaround, this library uses an admin account and Mechanize to sign into
+    the website and manually fill out forms and screenscrape the results. I hope
+    that the API's breadth of functionality improves in the future.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/wtforum/session.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module WTForum
+  class Session
+    def self.create user_id
+      uri = create_uri(user_id)
+      page = Mechanize.new.get(uri)
+      auth_token = WTForum.extract_value(:authtoken, :from => page.body)
+      new(auth_token)
+    end
+
+    def initialize token
+      @token = token
+    end
+
+    attr_reader :token
+
+    private
+
+    def self.create_uri user_id
+      uri = WTForum.base_api_uri(userid: user_id)
+      uri.path = "/register/setauthtoken"
+      uri
+    end
+  end
+end

data/lib/wtforum/user.rb

@@ -0,0 +1,153 @@
+# encoding: utf-8
+
+require "securerandom"
+
+module WTForum
+  class User
+    class NotFound < StandardError; end
+
+    def self.create attributes
+      defaults = { pw: SecureRandom.hex(10) }
+      attributes[:member] ||= attributes.delete(:username)
+      attributes.reverse_merge! defaults
+      uri = create_uri attributes
+
+      page = agent.get(uri)
+      user_id = WTForum.extract_value(:userid, :from => page.body)
+      attributes[:id] = user_id.to_i
+      new(attributes)
+    end
+
+    def self.find user_id
+      page = authorized_agent.get(find_uri(user_id))
+      raise NotFound if page.body.include?("Error: The specified account was not found")
+
+      body = Nokogiri::HTML.parse(page.body)
+      attributes = {
+        id: user_id,
+        member: body.css(".tables td:contains('Username:') + td input").first["value"],
+        email: body.css(".tables td:contains('Email Address:') + td").first.text.split(" - ").first,
+      }
+      new(attributes)
+    end
+
+    def self.update user_id, attributes
+      find(user_id).update_attributes!(attributes)
+    end
+
+    def self.delete user_id
+      authorized_agent.get delete_uri(user_id)
+      true
+    end
+
+    def self.count
+      page = agent.get(count_uri)
+      count = page.body.match(/Members \(([\d,]+)\)/)[1]
+      count.gsub(",", "").to_i
+    end
+
+    def initialize attributes
+      self.attributes = attributes
+    end
+
+    def update_attributes! attributes
+      self.attributes = attributes
+      save!
+    end
+
+    def save!
+      self.class.authorized_agent.get(self.class.edit_username_uri(id)) do |page|
+        form = page.forms.first
+        form["new_username"] = username
+        form.submit
+      end
+      self.class.authorized_agent.get(self.class.edit_email_uri(id)) do |page|
+        form = page.forms.first
+        form["email"] = email
+        form.submit
+      end
+    end
+
+    def destroy
+      self.class.delete id
+    end
+
+    attr_accessor :id, :member, :email
+    attr_writer :pw, :apikey
+
+    def username
+      member
+    end
+
+    def username= value
+      self.member = value
+    end
+
+    private
+
+    def attributes=(attributes={})
+      attributes.each do |key, value|
+        send :"#{key}=", value
+      end
+    end
+
+    def self.agent
+      Mechanize.new
+    end
+
+    def self.authorized_agent
+      @authorized_agent ||= begin
+        a = agent
+        a.get(login_uri)
+        a
+      end
+    end
+
+    def self.login_uri
+      uri = WTForum.base_uri
+      uri.path = "/register/dologin"
+      uri.query = "member=#{WTForum.admin_username}&pw=#{WTForum.admin_password}&remember=checked"
+      uri
+    end
+
+    def self.create_uri attributes
+      uri = WTForum.base_api_uri(attributes)
+      uri.path = "/register/create_account"
+      uri
+    end
+
+    def self.find_uri user_id
+      uri = WTForum.base_uri
+      uri.path = "/register/register"
+      uri.query = "edit=1&userid=#{user_id}"
+      uri
+    end
+
+    def self.edit_username_uri user_id
+      uri = WTForum.base_uri
+      uri.path = "/register/edit_username"
+      uri.query = "userid=#{user_id}"
+      uri
+    end
+
+    def self.edit_email_uri user_id
+      uri = WTForum.base_uri
+      uri.path = "/register/edit_password"
+      uri.query = "userid=#{user_id}"
+      uri
+    end
+
+    def self.count_uri
+      uri = WTForum.base_uri
+      uri.path = "/register/members"
+      uri
+    end
+
+    def self.delete_uri user_id
+      uri = WTForum.base_uri
+      uri.path = "/register/delete"
+      uri.query = "mem_userid=#{user_id}"
+      uri
+    end
+  end
+end

data/lib/wtforum/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module WTForum
+  VERSION = "0.0.1"
+end

data/lib/wtforum.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require "uri"
+require "active_support/core_ext/object"
+require "mechanize"
+require "nokogiri"
+
+require "wtforum/user"
+require "wtforum/session"
+
+module WTForum
+  class << self
+    attr_accessor :domain, :api_key, :admin_username, :admin_password
+
+    def base_uri
+      URI("http://#{domain}")
+    end
+
+    def base_api_uri attributes
+      attributes[:apikey] = api_key
+      uri = base_uri
+      uri.query = attributes.to_param
+      uri
+    end
+
+    def extract_value key, options
+      xml = Nokogiri::XML.parse(options[:from])
+      node = xml.css(key.to_s)
+      if node.present?
+        node.text
+      else
+        raise xml.css("error, .errorMsg").text
+      end
+    end
+  end
+end

data/spec/integration/wtforum_session_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe WTForum::Session do
+  let(:user) do
+    WTForum::User.create username: "wtforum_test_user", email: "wtforum_test_user@example.com"
+  end
+  after { user.destroy }
+
+  it "can log in users" do
+    session = WTForum::Session.create(user.id)
+    session.token.should match(/^[a-z0-9]{11}$/i)
+  end
+end

data/spec/integration/wtforum_user_spec.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe WTForum::User do
+  it "can CRUD users" do
+    begin
+      user = nil
+
+      lambda {
+        user = WTForum::User.create username: "wtforum_test_user", email: "wtforum_test_user@example.com"
+      }.should change(WTForum::User, :count).by(1)
+
+      user = WTForum::User.find(user.id)
+      user.username.should == "wtforum_test_user"
+      user.email.should == "wtforum_test_user@example.com"
+
+      user.update_attributes! username: "wtforum_test_user_2", email: "wtforum_test_user_2@example.com"
+
+      user = WTForum::User.find(user.id)
+      user.username.should == "wtforum_test_user_2"
+      user.email.should == "wtforum_test_user_2@example.com"
+
+    ensure
+      lambda {
+        user.destroy
+      }.should change(WTForum::User, :count).by(-1)
+    end
+  end
+
+  it "raises an exception when a user is not found" do
+    lambda {
+      WTForum::User.find(0)
+    }.should raise_exception(WTForum::User::NotFound)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require "wtforum"
+
+begin
+  require "./spec/support/credentials.rb"
+rescue LoadError
+  puts %(
+    To run the tests, you must create a login credentials file at spec/support/credentials.rb. Example:
+
+    WTForum.domain = "forum.example.com"
+    WTForum.api_key = "TEgPYR4Zapz"
+    WTForum.admin_username = "__admin_api_dont_delete__"
+    WTForum.admin_password = "s0m3p4ssw0rd"
+  )
+  exit
+end
+

data/wtforum.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wtforum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wtforum"
+  spec.version       = WTForum::VERSION
+  spec.authors       = ["Micah Geisel"]
+  spec.email         = ["micah@botandrose.com"]
+  spec.description   = %q{Ruby library that wraps Website Toolbox's forum API.}
+  spec.summary       = %q{Ruby library that wraps Website Toolbox's forum API.}
+  spec.homepage      = "https://github.com/botandrose/wtforum"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "activesupport"
+  spec.add_dependency "mechanize"
+  spec.add_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: wtforum
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Micah Geisel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: activesupport
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: mechanize
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: nokogiri
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: Ruby library that wraps Website Toolbox's forum API.
+email:
+- micah@botandrose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wtforum.rb
+- lib/wtforum/session.rb
+- lib/wtforum/user.rb
+- lib/wtforum/version.rb
+- spec/integration/wtforum_session_spec.rb
+- spec/integration/wtforum_user_spec.rb
+- spec/spec_helper.rb
+- wtforum.gemspec
+homepage: https://github.com/botandrose/wtforum
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      hash: 1995096068077646637
+      segments:
+      - 0
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      hash: 1995096068077646637
+      segments:
+      - 0
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby library that wraps Website Toolbox's forum API.
+test_files:
+- spec/integration/wtforum_session_spec.rb
+- spec/integration/wtforum_user_spec.rb
+- spec/spec_helper.rb