walkscore 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/lib/walkscore/api_key.rb

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 michael verdi
+
+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,35 @@
+# Walkscore
+This is a gem for interacting with the Walkscore Api.  You can easily request the walkscore of any given city by just passing in the lat and long of a given city.  You will need an API key from walkscore first.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'walkscore'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install walkscore
+
+## Usage
+
+### There is only one external method you will be using to interact with the api.
+
+### WalkscoreApi::Walkscore.find({lat: 40.7143528 , long: -74.00597309999999 }, API_KEY)
+That's it!  You're response will be a Walkscore object where you have access to the following methods
++ score
++ description
++ updated
++ logo_url
++ ws_link
++ Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/walkscore.rb

@@ -0,0 +1,4 @@
+require "walkscore/api_key"
+require "walkscore/version"
+require "walkscore/client"
+require "walkscore/walkscore"

data/lib/walkscore/client.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+
+module WalkscoreApi
+  class Client
+    BASE_URL = 'http://api.walkscore.com'
+
+    def initialize
+      @connection = Faraday.new(BASE_URL)
+    end
+
+    def make_connection(location, api_key)
+      response = @connection.get do |req|
+        req.url '/score'
+        req.headers['Accepts'] = 'application/json'
+        req.params['format'] = 'json'
+        req.params['lat'] = location[:lat]
+        req.params['lon'] = location[:long]
+        req.params['wsapikey'] = api_key
+      end
+      response.body
+    end
+  end
+end

data/lib/walkscore/version.rb

@@ -0,0 +1,3 @@
+module Walkscore
+  VERSION = "0.0.2"
+end

data/lib/walkscore/walkscore.rb

@@ -0,0 +1,24 @@
+require 'json'
+
+module WalkscoreApi
+  class Walkscore
+    attr_accessor :score, :description, :updated, :logo_url, :ws_link
+
+    def initialize(attributes)
+      self.score       = attributes['walkscore']
+      self.description = attributes['description']
+      self.updated     = attributes['updated']
+      self.logo_url    = attributes['logo_url']
+      self.ws_link     = attributes['ws_link']
+    end
+
+    def self.client
+      WalkscoreApi::Client.new
+    end
+
+    def self.find(location, api_key)
+      parsed_results = JSON.parse(client.make_connection(location, api_key))
+      WalkscoreApi::Walkscore.new(parsed_results)
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe WalkscoreApi::Client do
+  describe '#make_connection' do
+    context 'when making a get request to the walkscore api' do
+      it 'returns a status of 1 for successful connection' do
+        client = WalkscoreApi::Client.new
+        result = client.make_connection({lat: 40.7143528 , long: -74.00597309999999 }, API_KEY)
+        JSON.parse(result)['status'].should == 1
+      end
+
+      it 'returns a status of 40 for unsuccessful connection' do
+        client = WalkscoreApi::Client.new
+        result = client.make_connection({lat: 40.7143528 , long: -74.00597309999999 }, 'some_random_text')
+        JSON.parse(result)['status'].should == 40
+      end
+
+      it 'returns a status of 30 for invalid location connection' do
+        client = WalkscoreApi::Client.new
+        result = client.make_connection({lat: -0.7143528 , long: 345.0059 }, API_KEY)
+        JSON.parse(result)['status'].should == 30
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require './lib/walkscore'

data/spec/walkscore_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+class MockClient
+  def make_connection(location, api_key)
+    <<-eos
+      {\n\"status\": 1  \n,
+       \"walkscore\": 100\n,
+       \"description\": \"Walker's Paradise\"\n,
+       \"updated\": \"2012-06-27 23:22:43.598005\" \n,
+       \"logo_url\": \"http://www2.walkscore.com/images/api-logo.gif\"\n,
+       \"more_info_icon\": \"http://www2.walkscore.com/images/api-more-info.gif\"\n,
+       \"more_info_link\": \"http://www.walkscore.com/how-it-works.shtml\"\n, \"ws_link\": \"http://www.walkscore.com/score/loc/lat=40.7143528/lng=-74.00597309999999/?utm_source=dynamiteurbanite.com&utm_medium=ws_api&utm_campaign=ws_api\"\n,
+       \"snapped_lat\": 40.7145\n,
+       \"snapped_lon\": -74.0055  \n\n\n\n}
+    eos
+  end
+end
+
+describe WalkscoreApi::Walkscore do
+  before(:each) do
+    WalkscoreApi::Walkscore.stub(:client).and_return(MockClient.new)
+  end
+
+  describe '.find(location, api_key)' do
+    it 'returns an instance of WalkscoreApi::Walkscore' do
+      WalkscoreApi::Walkscore.find({lat: 40.7143528 , long: -74.00597309999999}, API_KEY).should be_a(WalkscoreApi::Walkscore)
+    end
+  end
+end

data/walkscore.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/walkscore/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["michael verdi"]
+  gem.email         = ["michael.v.verdi@gmail.com"]
+  gem.description   = %q{Wrapper for the Walkscore Api}
+  gem.summary       = %q{Wrapper for the Walkscore Api}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "walkscore"
+  gem.require_paths = ["lib"]
+  gem.version       = Walkscore::VERSION
+
+  gem.add_runtime_dependency('faraday')
+  gem.add_development_dependency('rspec')
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: walkscore
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- michael verdi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70333941152160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70333941152160
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70333941151660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70333941151660
+description: Wrapper for the Walkscore Api
+email:
+- michael.v.verdi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/walkscore.rb
+- lib/walkscore/client.rb
+- lib/walkscore/version.rb
+- lib/walkscore/walkscore.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/walkscore_spec.rb
+- walkscore.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Wrapper for the Walkscore Api
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/walkscore_spec.rb