localwiki_client 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb9cc507732637d939aa2fdea6e73523e17b0765
-  data.tar.gz: c2eaa613db6c5df7cb2dad1940d693fa0a16907b
+  metadata.gz: e86f427d07f0b2f5fdb68ce988290fdca41d3e79
+  data.tar.gz: 1457723a76e10dc292dc4aaeb453e2ac101c7e78
 SHA512:
-  metadata.gz: a62093cafaa6429868d66ff1c4a15187f37c9e93b8fec8666bc9d36602884feba589b18a201aca253aee61e57b193e3d72c61b023ac4acd3dfdd7113cb94fc60
-  data.tar.gz: 6368549d3fa07caf1678080786626cbcd14442c1864ed176774ce6ef80665a7b6190f0f15b467b8da57dabbd13db055da09b9d62cea6c82f3d0e083c840dbe9a
+  metadata.gz: f8bd7d85ae999853e62e2de954b71f2c6efbf076546ccd6ed3efd9f3304fa87f26ed45978c71fa20368e8e9591da2c35698939097f9b8749cb65948b8293eb8c
+  data.tar.gz: 65c4b102cc369045bfcf431b1c45a5116eb685fce1b0e9c91b6738bd4ecd8dbc37f568866c94fe512f25474fa09d48ec68796f587cd494a39f0e721eb526432a

data/.travis.yml

@@ -4,3 +4,5 @@ rvm:
   - 2.0.0
   - jruby-19mode # JRuby in 1.9 mode
   - rbx-19mode
+env:
+  - localwiki_client_server=ec2-54-234-151-52.compute-1.amazonaws.com

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.3.1 / 2013-04-02
+
+* Follow redirects
+* Added example scripts
+
 === 0.3.0 / 2013-03-28
 
 * Localwiki::Resource subclasses used to represent resources

data/README.md

@@ -43,6 +43,8 @@ Usage
     response.status
     => 201
 
+More examples scripts can be found in the [examples folder](https://github.com/codeforseattle/localwiki_client/tree/master/examples).
+
 Features / Problems
 -------------------
 
@@ -63,21 +65,17 @@ Compatibility
 Contributing
 ------------
 
-To get your improvements included, please fork and submit a pull request.
-
-Bugs and/or failing tests are very appreciated.
+* To get your improvements included, please fork and submit a pull request.
+* Bugs and/or failing tests are very appreciated.
+* See [Contributing to localwiki_client gem](https://github.com/codeforseattle/localwiki_client/wiki/Contributing-to-localwiki_client-gem) for additional details.
 
 Contributors
 ------------
-Seth Vincent
-
-Brandon Faloona
-
-Helen Canzler
-
-Jerry Frost
-
-Matt Adkins
+* Seth Vincent
+* Brandon Faloona
+* Helen Canzler
+* Jerry Frost
+* Matt Adkins
 
 LICENSE
 -------

data/examples/localwiki_stats.rb

@@ -0,0 +1,102 @@
+require 'localwiki_client'
+
+##
+# Written by Seth Vincent, Brandon Faloona
+#
+# LocalWiki API doc:
+# localwiki.readthedocs.org/en/latest/api.html
+
+localwikis = [
+                'wikislo.org',
+                'miamiwiki.org',
+                'oaklandwiki.org',
+                'saltlakewiki.org',
+                'seattlewiki.net',
+                'cuwiki.net',
+                'conway.localwiki.org',
+                'viget.org',
+                'olywiki.org',
+                'www.bmorepipeline.org',
+                'wikikc.com',
+                'toledowiki.net',
+                'arborwiki.org',
+                'oshima-gdm.jp',
+                'dentonwiki.org',
+                'trianglewiki.org',
+                'scruzwiki.org',
+                'boise.localwiki.org',
+                'antarctica.localwiki.org',
+                'sacwiki.org',
+                'denver-wiki.org',
+                'tacoma.localwiki.org',
+                'denver-wiki.org',
+                'taswiki.net',
+                'barkerwiki.org.au',
+                'sydney.localwiki.org',
+                'southshorewiki.ca',
+                'toronto.localwiki.org',
+                'sfwiki.org',
+                'www.sdwiki.org',
+                'www.wikiofgoodliving.org',
+                'chicowiki.org',
+                'foothills.localwiki.org',
+                'www.newbritainwiki.org',
+                'www.gainesvillewiki.org',
+                'www.tallahasseewiki.org',
+                'decorahwiki.org',
+                'cantonwiki.org',
+                'detroitwiki.org',
+                'wiki.betteralamance.org',
+                'wikikc.org',
+                'twincitieswiki.org',
+                'porttownsendwiki.org',
+                'austin.localwiki.org',
+                'www.mac-wiki.org',
+                'tulsawiki.org',
+                'districtcommons.org',
+                'www.utkalen.se',
+                'www.nquarter.co.uk',
+                'hyderabadwiki.com',
+                'sissachwiki.ch',
+                'www.kingslynnwiki.co.uk',
+                'bermudawiki.org'
+              ]
+
+def get_wiki_stats(base_url)
+
+  wiki = LocalwikiClient.new base_url
+  site_thread = Thread.current
+  site_thread[:output] = []
+
+  wiki_name = wiki.site.name << "\n"
+
+  resource_types = ['page', 'user', 'file', 'map']
+  resource_types.collect do |resource|
+    label = "  #{resource.to_s}s: "
+    site_thread[:output].push "#{label[0..7]} #{wiki.count(resource).to_s.rjust(6)}"
+  end
+
+  site_thread[:output].sort!.reverse!
+  puts wiki_name << site_thread[:output].join("\n")
+
+end
+
+# for each localwiki, create a thread to collect and print stats
+site_threads = localwikis.collect do |wiki|
+
+  Thread.new do
+    begin
+
+      sleep 0.05
+      get_wiki_stats(wiki)
+
+    rescue Errno::ETIMEDOUT => timeout
+      puts "#{wiki} timed out."
+    rescue => e
+      puts "#{wiki} returned the error: #{e.message}"
+    end
+  end
+end
+
+puts "Collecting stats on #{site_threads.count} wikis ..."
+site_threads.collect &:join

data/examples/nearby_wiki_pages.rb

@@ -0,0 +1,48 @@
+require 'localwiki_client'
+require 'geocoder'
+require 'uri'
+
+def print_help
+  puts 'Return list of wiki pages (that have location information) near a street address.'
+  puts "Parameters:"
+  puts "\thostname: localwiki server, e.g.: seattlewiki.net"
+  puts "\taddress: street address, e.g.: 350 Monroe Avenue NE, Renton WA"
+  puts "\tmiles: number of miles to search (defaults to 1)"
+  puts "Usage:\n\tnearby_wiki_pages <hostname> <street address> <miles>"
+  exit
+end
+
+def uri_to_name uri
+  URI.decode(uri.match(/\/([^\/]+)$/)[1]).gsub('_', ' ')
+end
+
+print_help if ARGV.length < 2
+
+hostname, address, miles = ARGV
+
+coordinates = Geocoder.coordinates address
+puts "Finding wiki pages within #{miles} miles of #{coordinates.inspect}"
+
+wiki = LocalwikiClient.new hostname
+maps = wiki.list :map
+#puts maps.inspect
+
+pages = maps.collect do |map|
+  next unless map.single_point?
+  actual_distance = Geocoder::Calculations.distance_between([map.lat, map.long], coordinates.reverse)
+  #puts actual_distance.to_s + ' :: ' + map.page
+  if actual_distance < miles.to_f
+    #print '.'
+    {:dist => actual_distance, :map => map}
+  end
+end
+
+pages.compact!
+if pages.size < 1
+  puts 'No results found.'
+else
+  puts "\nMiles :: Page"
+  pages.sort_by{|i|i[:dist]}.each do |entry|
+    puts sprintf("%5.2f", entry[:dist]) + " :: #{uri_to_name(entry[:map].page)}"
+  end
+end

data/integration/helper.rb

@@ -2,8 +2,11 @@ $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require 'localwiki_client'
 
 def test_env_vars_set?
-  return true if ENV['localwiki_client_user'] && ENV['localwiki_client_apikey']
+  return true if ENV['localwiki_client_server'] && ENV['localwiki_client_user'] && ENV['localwiki_client_apikey']
   puts "\nTo run all tests in the integration folder you need to do two things:"
-  puts "\tContact sethvincent@gmail.com to request a username and apikey on the test server."
-  puts "\tSet these two environment variables:\n\t\texport localwiki_client_user=USERNAME\n\t\texport localwiki_client_apikey=APIKEY"
+  puts "\tContact a test server admin to request the hostname, and a username / apikey for your test server."
+  puts "\tSet these three environment variables (working example given):"
+  puts "\t\texport localwiki_client_server=ec2-54-234-151-52.compute-1.amazonaws.com"
+  puts "\t\texport localwiki_client_user=testuser"
+  puts "\t\texport localwiki_client_apikey=1ff0ed07625365b8d5589f17088f43b5ae227793"
 end

data/integration/live_test_wiki_spec.rb

@@ -51,11 +51,11 @@ describe 'LIVE testwiki instance' do
     end
 
     it "returns collection of resources objects" do
-      @response['objects'].first.keys.length.should be > 1
+      @response.first.class.superclass.should eq Localwiki::Resource
     end
 
     it "limit parameter limits number of resources returned" do
-      @response['objects'].length.should eq 2
+      @response.length.should eq 2
     end
 
   end

data/lib/localwiki/client.rb

@@ -1,4 +1,5 @@
 require 'faraday'
+require 'faraday_middleware'
 require 'json'
 
 module Localwiki
@@ -161,7 +162,7 @@ module Localwiki
     # @return [Localwiki::Resource, Faraday::Response] resource object, or http response object
     def hydrate(resource_type,param)
       # skip if given an http response object
-      return param if param.respond_to? :status
+      return param if param.kind_of? Faraday::Response
       Localwiki::make_one(resource_type,param)
     end
 
@@ -172,7 +173,7 @@ module Localwiki
     # @return [Array, Faraday::Response] array of resource objects, or http response object
     def hydrate_list(resource_type,param)
       # skip if given an http response object
-      return param if param.respond_to? :status
+      return param if param.kind_of? Faraday::Response
       param.collect do |json_hash|
         Localwiki::make_one(resource_type,json_hash)
       end
@@ -182,8 +183,13 @@ module Localwiki
     # initialize Faraday::Connection instance. set @conn and @site
     # @param [String] hostname localwiki server hostname
     def initialize_connection(hostname)
-      @conn = Faraday.new :url => hostname
+      @conn = Faraday.new url: hostname do |config|
+        config.use FaradayMiddleware::FollowRedirects, limit: 3
+        # config.use Faraday::Response::RaiseError       # raise exceptions on 40x, 50x responses
+        config.adapter Faraday.default_adapter
+      end
       @site = fetch('site','1')
+      raise "Connection failed. #{@site.status} error returned from #{hostname}." if @site.kind_of? Faraday::Response
     end
   
     ##
@@ -204,10 +210,8 @@ module Localwiki
     # @return [Faraday::Response] http response object
     def http_post(path, json)
       @conn.post do |req|
-        req.url full_url(path)
-        req.headers['Content-Type'] = 'application/json'
-        req.headers['Authorization'] = "ApiKey #{@user}:#{@apikey}"
-        req.body = json
+        configure_request req, path, json
+        authorize_request req
       end
     end
     
@@ -218,10 +222,8 @@ module Localwiki
     # @return [Faraday::Response] http response object
     def http_put(path, json)
       @conn.put do |req|
-        req.url full_url(path)
-        req.headers['Content-Type'] = 'application/json'
-        req.headers['Authorization'] = "ApiKey #{@user}:#{@apikey}"
-        req.body = json
+        configure_request req, path, json
+        authorize_request req
       end
     end
 
@@ -231,9 +233,8 @@ module Localwiki
     # @return [Faraday::Response] http response object
     def http_delete(path)
       @conn.delete do |req|
-        req.url full_url(path)
-        req.headers['Content-Type'] = 'application/json'
-        req.headers['Authorization'] = "ApiKey #{@user}:#{@apikey}"
+        configure_request req, path
+        authorize_request req
       end
     end
 
@@ -245,5 +246,23 @@ module Localwiki
       string.to_s.strip.gsub(' ', "_")
     end
 
+    ##
+    # set request parameters
+    # @param req Faraday request object
+    # @param path request path
+    # @param json json string
+    def configure_request(req, path, json=nil)
+      req.headers['Content-Type'] = 'application/json'
+      req.url full_url(path)
+      req.body = json
+    end
+
+    ##
+    # set request authorization header
+    # @param req Faraday request object
+    def authorize_request(req)
+      req.headers['Authorization'] = "ApiKey #{@user}:#{@apikey}"
+    end
+
   end
 end

data/lib/localwiki/version.rb

@@ -1,5 +1,5 @@
 module Localwiki
 
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 
 end

data/localwiki_client.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9.2'
 
   s.add_dependency('faraday')
+  s.add_dependency('faraday_middleware')
   s.add_dependency('json_pure')
 
   s.add_development_dependency('rake')

data/spec/basic_crud_spec.rb

@@ -4,7 +4,7 @@ describe 'LocalwikiClient' do
 
   before(:all) do
     VCR.insert_cassette 'basic_crud', :record => :new_episodes
-    @wiki = Localwiki::Client.new 'ec2-54-234-151-52.compute-1.amazonaws.com',
+    @wiki = Localwiki::Client.new ENV['localwiki_client_server'],
                                   ENV['localwiki_client_user'],
                                   ENV['localwiki_client_apikey']
     require 'securerandom'

data/spec/basic_spec.rb

@@ -6,7 +6,7 @@ describe 'LocalwikiClient' do
 
     before(:all) do
       VCR.insert_cassette 'basic', :record => :new_episodes
-      @wiki = Localwiki::Client.new 'ec2-54-234-151-52.compute-1.amazonaws.com',
+      @wiki = Localwiki::Client.new ENV['localwiki_client_server'],
                                     ENV['localwiki_client_user'],
                                     ENV['localwiki_client_apikey']
     end

data/spec/fetch_version_spec.rb

@@ -4,7 +4,7 @@ describe 'LocalwikiClient' do
 
   before(:all) do
     VCR.insert_cassette 'fetch', :record => :new_episodes
-    @wiki = Localwiki::Client.new 'ec2-54-234-151-52.compute-1.amazonaws.com',
+    @wiki = Localwiki::Client.new ENV['localwiki_client_server'],
                                   ENV['localwiki_client_user'],
                                   ENV['localwiki_client_apikey']
     require 'securerandom'

data/spec/helper.rb

@@ -16,8 +16,11 @@ VCR.configure do |c|
   # c.debug_logger = File.open('spec/fixtures/cassettes/debug_vcr.log', 'w')
 end
 
-unless ENV['localwiki_client_user'] && ENV['localwiki_client_apikey']
+unless ENV['localwiki_client_server'] && ENV['localwiki_client_user'] && ENV['localwiki_client_apikey']
   puts "\nTo add or modify tests in the spec folder you need to do two things:"
-  puts "\tContact sethvincent@gmail.com to request a username and apikey on the test server."
-  puts "\tSet these two environment variables:\n\t\texport localwiki_client_user=USERNAME\n\t\texport localwiki_client_apikey=APIKEY"
+  puts "\tContact a test server admin to request the hostname, and a username / apikey for your test server."
+  puts "\tSet these three environment variables (working example given):"
+  puts "\t\texport localwiki_client_server=ec2-54-234-151-52.compute-1.amazonaws.com"
+  puts "\t\texport localwiki_client_user=testuser"
+  puts "\t\texport localwiki_client_apikey=1ff0ed07625365b8d5589f17088f43b5ae227793"
 end

data/spec/list_spec.rb

@@ -4,7 +4,7 @@ describe 'LocalwikiClient' do
 
   before(:all) do
     VCR.insert_cassette 'list', :record => :new_episodes
-    @wiki = Localwiki::Client.new 'ec2-54-234-151-52.compute-1.amazonaws.com',
+    @wiki = Localwiki::Client.new ENV['localwiki_client_server'],
                                   ENV['localwiki_client_user'],
                                   ENV['localwiki_client_apikey']
     require 'securerandom'

data/spec/localwiki_client_spec.rb

@@ -4,7 +4,7 @@ describe 'LocalwikiClient' do
 
   before(:all) do
     VCR.insert_cassette 'localwiki_client', :record => :new_episodes
-    @wiki = Localwiki::Client.new 'ec2-54-234-151-52.compute-1.amazonaws.com'
+    @wiki = Localwiki::Client.new ENV['localwiki_client_server']
   end
 
   after(:all) do

data/spec/slug_spec.rb

@@ -4,7 +4,7 @@ describe 'LocalwikiClient' do
 
   before(:all) do
     VCR.insert_cassette 'slug', :record => :new_episodes
-    @wiki = Localwiki::Client.new 'ec2-54-234-151-52.compute-1.amazonaws.com',
+    @wiki = Localwiki::Client.new ENV['localwiki_client_server'],
                                   ENV['localwiki_client_user'],
                                   ENV['localwiki_client_apikey']
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: localwiki_client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Brandon Faloona
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-29 00:00:00.000000000 Z
+date: 2013-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -25,6 +25,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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'
 - !ruby/object:Gem::Dependency
   name: json_pure
   requirement: !ruby/object:Gem::Requirement
@@ -213,6 +227,8 @@ files:
 - History.txt
 - README.md
 - Rakefile
+- examples/localwiki_stats.rb
+- examples/nearby_wiki_pages.rb
 - integration/helper.rb
 - integration/live_saltlake_wiki_spec.rb
 - integration/live_test_wiki_spec.rb
@@ -258,7 +274,7 @@ homepage: http://github.com/bfaloona/localwiki_client
 licenses:
 - MIT
 metadata: {}
-post_install_message: "\n    Thank you for installing localwiki_client 0.3.0\n  "
+post_install_message: "\n    Thank you for installing localwiki_client 0.3.1\n  "
 rdoc_options:
 - --charset=UTF-8
 require_paths:
@@ -278,6 +294,6 @@ rubyforge_project:
 rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
-summary: localwiki_client-0.3.0
+summary: localwiki_client-0.3.1
 test_files: []
 has_rdoc: