localwiki_client 0.0.3

data/.gitignore

@@ -0,0 +1,2 @@
+.idea
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec', :cli => "--color --format d" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { "spec" }
+  watch('spec/helper.rb') { "spec" }
+end
+

data/History.txt

@@ -0,0 +1,13 @@
+=== 0.0.3 / 2013-01-05
+
+* Renamed to localwiki_client
+* #total_resources now uses &limit=1
+* #page_by_name
+
+=== 0.0.2 / 2013-01-03
+
+* Path and docs fixes
+
+=== 0.0.1 / 2013-01-03
+
+* It's Alive!

data/README.md

@@ -0,0 +1,58 @@
+LocalwikiClient
+===============
+
+Synopsis
+--------
+
+A thin client for the Localwiki API
+
+http://localwiki.readthedocs.org/en/latest/api.html
+
+Installation
+------------
+
+    $ gem install localwiki_client
+
+Usage
+-----
+
+## Example
+
+    require 'localwiki_client'
+    wiki = LocalwikiClient.new 'seattlewiki.net'
+    wiki.site_name
+    => SeattleWiki
+    wiki.total_resources('user')
+    => 47
+
+Contributing
+------------
+
+To get your improvements included, please fork and submit a pull request.
+Bugs and/or failing tests are very appreciated.
+
+LICENSE
+-------
+
+(The MIT License)
+
+Copyright (c) 2013 Brandon Faloona, Seth Vincent
+
+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/Rakefile

@@ -0,0 +1,33 @@
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Default: run tests'
+task :default => :test
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/*_spec.rb"
+  t.rspec_opts = ['-f d']
+end
+
+desc "Run tests"
+task :test do
+  Rake::Task['spec'].invoke
+end
+
+desc "Run integration tests"
+RSpec::Core::RakeTask.new(:integration) do |t|
+  t.pattern = "spec/integration/*_spec.rb"
+  t.rspec_opts = ['-f d']
+end
+
+desc "Flog the code! (*nix only)"
+task :flog do
+  system('find lib -name \*.rb | xargs flog')
+end
+
+desc "Detailed Flog report! (*nix only)"
+task :flog_detail do
+  system('find lib -name \*.rb | xargs flog -d')
+end

data/lib/localwiki_client.rb

@@ -0,0 +1,4 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'localwiki_client/localwiki_client'

data/lib/localwiki_client/localwiki_client.rb

@@ -0,0 +1,70 @@
+require 'rest-client'
+require 'json/pure'
+
+##
+# A client that wraps the localwiki api for a given server instance
+#
+class LocalwikiClient
+
+  attr_accessor :hostname       # hostname of the server we'd like to point at
+  attr_reader   :site_name      # site resource - display name of wiki
+  attr_reader   :time_zone      # site resource - time zone of server, e.g. 'America/Chicago'
+  attr_reader   :language_code  # site resource - language code of the server, e.g. 'en-us'
+
+  ##
+  # Creating a LocalWikiClient instance will get it's site resource data
+  #
+  #   LocalwikiClient.new 'seattlewiki.net'
+  #
+  def initialize hostname
+    @hostname = hostname
+    collect_site_details
+  end
+
+  ##
+  # Get site resource and set ivars
+  #
+  def collect_site_details
+    site = get_resource('site/1')
+    @site_name = site['name']
+    @time_zone = site['time_zone']
+    @language_code = site['language_code']
+  end
+
+  ##
+  # http get request
+  # url is formatted as http://[url-to-wiki]/[thing-you-want]&format=json
+  #
+  def get(resource,timeout=120)
+    response = RestClient::Request.execute(
+        :method => :get,
+        :url => 'http://' + @hostname + resource + '&format=json',
+        :timeout => timeout)
+    JSON.parse(response.body)
+  end
+
+  ##
+  # http get of a specfic type of resource
+  # resource_types are "site", "page", "user", "file", "map"
+  # limit is an integer
+  # filters is a querystring param in the form "&option=value"
+  def get_resource(content_type,limit=0,filters='')
+    resource = '/api/' + content_type + '?limit=' + limit.to_s + filters
+    get(resource)
+  end
+
+  ##
+  # Request total_count of given resource
+  #
+  def total_resources(content_type)
+    get_resource(content_type,1)["meta"]["total_count"]
+  end
+
+  ##
+  # Return a page that matches name ("The Page Name" or "The_Page_Name")
+  #
+  def page_by_name(name)
+    get_resource("page/#{name.gsub!(/\s/, '_')}")
+  end
+
+end

data/localwiki_client.gemspec

@@ -0,0 +1,38 @@
+Gem::Specification.new do |s|
+  s.name        = 'localwiki_client'
+  s.version     = '0.0.3'
+  s.authors     = ["Brandon Faloona", "Seth Vincent"]
+  s.description = %{ A thin wrapper around the Localwiki API. }
+  s.summary     = "localwiki_client-#{s.version}"
+  s.email       = 'brandon@faloona.net'
+  s.homepage    = "http://github.com/bfaloona/LocalwikiClient"
+  s.license     = 'MIT'
+  s.platform    = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.add_dependency('rest-client')
+  s.add_dependency('json')
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '>= 2.9.0')
+  s.add_development_dependency('rspec-mocks', '>= 2.9.0')
+  s.add_development_dependency('rb-fsevent')
+
+  unless ENV['TRAVIS'] == 'true'
+    s.add_development_dependency('flog')
+    s.add_development_dependency('guard')
+    unless ENV['RUBY_VERSION'] &&  ENV['RUBY_VERSION'].match(/jruby|rbx/)
+      s.add_development_dependency('guard-rspec')
+    end
+  end
+
+
+  s.post_install_message =
+  %{
+    Thank you for installing localwiki_client #{s.version}
+  }
+
+  s.files             = `git ls-files`.split("\n")
+  s.rdoc_options      = ["--charset=UTF-8"]
+  s.require_path      = "lib"
+end

data/spec/integration/live_saltlake_wiki_spec.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require 'localwiki_client'
+
+describe 'LIVE saltlakewiki.org' do
+
+  subject { LocalwikiClient.new 'saltlakewiki.org' }
+
+  context '#time_zone' do
+    it {subject.time_zone.should eq 'America/Chicago' }
+  end
+
+  context '#language_code' do
+    it {subject.language_code.should eq 'en-us'}
+  end
+
+  context '#total_resources("user")' do
+    it {subject.total_resources('user').to_i.should > 2}
+  end
+
+end

data/spec/localwiki_client_spec.rb

@@ -0,0 +1,74 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'localwiki_client'
+require 'rspec/mocks'
+
+describe 'LocalwikiClient' do
+
+  context 'Site details' do
+    subject { LocalwikiClient.new 'mockwiki.foo' }
+
+    before(:each) do
+      response = double('response')
+      response.stub(:body) {
+        %q[{"domain": "mockwiki.foo", "id": 1, "language_code": "en-us", "license": "<p>Except where otherwise noted, this content is licensed under a <a rel=\" license\" href=\"http://creativecommons.org/licenses/by/3.0/\">Creative Commons Attribution License</a>. See <a href=\"/Copyrights\">Copyrights.</p>", "name": "Salt Lake Wiki", "resource_uri": "/api/site/1", "signup_tos": "I agree to release my contributions under the <a rel=\"license\" href=\"http://creativecommons.org/licenses/by/3.0/\" target=\"_blank\">Creative Commons-By license</a>, unless noted otherwise. See <a href=\"/Copyrights\" target=\"_blank\">Copyrights</a>.","time_zone": "America/Chicago"}]
+      }
+      RestClient::Request.should_receive(:execute
+        ).with(
+          {:method => :get,
+           :url => 'http://mockwiki.foo/api/site/1?limit=0&format=json',
+           :timeout => 120}
+        ).and_return(response)
+    end
+
+    it {should respond_to :hostname}
+    it {should respond_to :site_name}
+    it {should respond_to :time_zone}
+    it {should respond_to :language_code}
+    it {should respond_to :total_resources}
+    it {should respond_to :page_by_name}
+
+    context 'mockwiki.foo' do
+
+      context '#time_zone' do
+        it {subject.time_zone.should eq 'America/Chicago' }
+      end
+
+      context '#language_code' do
+        it {subject.language_code.should eq 'en-us'}
+      end
+
+      context '#total_resources("user")' do
+        it 'should eq 6' do
+          response = double('response')
+          response.stub(:body) {
+            %q<{"meta": {"limit": 0, "offset": 0, "total_count": 6}, "objects": [{"date_joined": "2012-10-05T21:12:34.103559", "first_name": "", "last_name": "", "resource_uri": "", "username": "AnonymousUser"}, {"date_joined": "2012-11-02T15:24:44.621040", "first_name": "Kris", "last_name": "Trujillo", "resource_uri": "/api/user/3", "username": "kristrujillo"}, {"date_joined": "2012-10-17T14:01:40.778496", "first_name": "Tod", "last_name": "Robbins", "resource_uri": "/api/user/2", "username": "todrobbins"}, {"date_joined": "2012-11-20T21:47:33.152069", "first_name": "Jessie", "last_name": "", "resource_uri": "/api/user/4", "username": "jessiepech"}, {"date_joined": "2012-10-05T21:12:33", "first_name": "Andrew", "last_name": "Sullivan", "resource_uri": "/api/user/1", "username": "licyeus"}, {"date_joined": "2012-12-08T15:33:29.251275", "first_name": "Ryan", "last_name": "", "resource_uri": "/api/user/5", "username": "saltlakeryan"}]}>
+          }
+          RestClient::Request.should_receive(:execute
+            ).with(
+                {:method => :get,
+                 :url => 'http://mockwiki.foo/api/user?limit=1&format=json',
+                 :timeout => 120}
+            ).and_return(response)
+          subject.total_resources('user').should eq 6
+        end
+      end
+
+      context "#page_by_name('Luna Park Cafe')" do
+        it 'has content matching "amusement park"' do
+          response = double('response')
+          response.stub(:body) {
+            %q[{"content": "<p>\n\t </p>\n<table class=\"details\">\n\t<tbody>\n\t\t<tr>\n\t\t\t<td style=\"background-color: rgb(232, 236, 239);\">\n\t\t\t\t<strong>Location</strong></td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>\n\t\t\t\t<p>\n\t\t\t\t\t2918 Southwest Avalon Way</p>\n\t\t\t\t<p>\n\t\t\t\t\tSeattle, WA 98126</p>\n\t\t\t</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td style=\"background-color: rgb(232, 236, 239);\">\n\t\t\t\t<strong>Hours</strong></td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>\n\t\t\t\t7am - 10pm Everyday</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td style=\"background-color: rgb(232, 236, 239);\">\n\t\t\t\t<strong>Phone</strong></td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>\n\t\t\t\t(206) 935-7250</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td style=\"background-color: rgb(232, 236, 239);\">\n\t\t\t\t<strong>Website</strong></td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>\n\t\t\t\t<a href=\"http://www.lunaparkcafe.com/\">lunaparkcafe.com</a></td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td style=\"background-color: rgb(232, 236, 239);\">\n\t\t\t\t<strong>Established</strong></td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>\n\t\t\t\tMarch 18th, 1989</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td style=\"background-color: rgb(232, 236, 239);\">\n\t\t\t\t<strong>Price range</strong></td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>\n\t\t\t\t$10</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td style=\"background-color: rgb(232, 236, 239);\">\n\t\t\t\t<strong>Payment Methods</strong></td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>\n\t\t\t\tCash, credit cards</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td style=\"background-color: rgb(232, 236, 239);\">\n\t\t\t\t<strong>Wheelchair accessibility</strong></td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>\n\t\t\t\tNo stairs.</td>\n\t\t</tr>\n\t</tbody>\n</table>\n<p>\n\tFantastic diner filled with historic references to the Luna Park amusement park.</p>\n<p>\n\t<span class=\"image_frame image_frame_border\"><img src=\"_files/luna_park_cafe_front.jpg\" style=\"width: 300px; height: 225px;\"></span><span class=\"image_frame image_frame_border\"><img src=\"_files/luna_park_cafe_batmobile_ride.jpg\" style=\"width: 300px; height: 225px;\"></span></p>\n<h3>\n\tRelated Links</h3>\n<ul>\n\t<li>\n\t\t<a href=\"Restaurants\">Restaurants</a></li>\n</ul>\n<p>\n\t </p>\n", "id": 572, "map": "/api/map/Luna_Park_Cafe", "name": "Luna Park Cafe", "page_tags": "/api/page_tags/Luna_Park_Cafe", "resource_uri": "/api/page/Luna_Park_Cafe", "slug": "luna park cafe"}]
+          }
+          RestClient::Request.should_receive(:execute
+            ).with(
+              {:method => :get,
+               :url => 'http://mockwiki.foo/api/page/Luna_Park_Cafe?limit=0&format=json',
+               :timeout => 120}
+            ).and_return(response)
+          subject.page_by_name('Luna Park Cafe')['content'].should match(/amusement park/)
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: localwiki_client
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Brandon Faloona
+- Seth Vincent
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' A thin wrapper around the Localwiki API. '
+email: brandon@faloona.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- History.txt
+- README.md
+- Rakefile
+- lib/localwiki_client.rb
+- lib/localwiki_client/localwiki_client.rb
+- localwiki_client.gemspec
+- spec/integration/live_saltlake_wiki_spec.rb
+- spec/localwiki_client_spec.rb
+homepage: http://github.com/bfaloona/LocalwikiClient
+licenses:
+- MIT
+post_install_message: ! "\n    Thank you for installing localwiki_client 0.0.3\n  "
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: localwiki_client-0.0.3
+test_files: []
+has_rdoc: