Permalink
Browse files

its basically perfect

  • Loading branch information...
0 parents commit 4521b5b2bb212c7c2ae540c3a862f4fa86b30263 @technoweenie committed Feb 16, 2011
Showing with 312 additions and 0 deletions.
  1. +1 −0 .rvmrc
  2. +2 −0 Gemfile
  3. +26 −0 Gemfile.lock
  4. +21 −0 LICENSE
  5. +151 −0 Rakefile
  6. +43 −0 lib/urban_api.rb
  7. +68 −0 urban_api.gemspec
1 .rvmrc
@@ -0,0 +1 @@
+rvm ruby-1.9.2-p136
@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec
@@ -0,0 +1,26 @@
+PATH
+ remote: .
+ specs:
+ NAME (0.0)
+ faraday (~> 0.5.6)
+ nokogiri (~> 1.4.4)
+
+GEM
+ remote: http://rubygems.org/
+ specs:
+ addressable (2.2.4)
+ faraday (0.5.6)
+ addressable (~> 2.2.4)
+ multipart-post (~> 1.1.0)
+ rack (>= 1.1.0, < 2)
+ multipart-post (1.1.0)
+ nokogiri (1.4.4)
+ rack (1.2.1)
+
+PLATFORMS
+ ruby
+
+DEPENDENCIES
+ NAME!
+ faraday (~> 0.5.6)
+ nokogiri (~> 1.4.4)
21 LICENSE
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Rick Olson
+
+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.
151 Rakefile
@@ -0,0 +1,151 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+ @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+ line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+ line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+ Date.today.to_s
+end
+
+def rubyforge_project
+ name
+end
+
+def gemspec_file
+ "#{name}.gemspec"
+end
+
+def gem_file
+ "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+ head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+ test.libs << 'lib' << 'test'
+ test.pattern = 'test/**/*_test.rb'
+ test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+ require 'rcov'
+ sh "rm -fr coverage"
+ sh "rcov test/*_test.rb"
+ sh "open coverage/index.html"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+ rdoc.rdoc_dir = 'rdoc'
+ rdoc.title = "#{name} #{version}"
+ rdoc.rdoc_files.include('README*')
+ rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+ sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+ unless `git branch` =~ /^\* master$/
+ puts "You must be on the master branch to release!"
+ exit!
+ end
+ sh "git commit --allow-empty -a -m 'Release #{version}'"
+ sh "git tag v#{version}"
+ sh "git push origin master"
+ sh "git push origin v#{version}"
+ sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+ sh "mkdir -p pkg"
+ sh "gem build #{gemspec_file}"
+ sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+ # read spec file and split out manifest section
+ spec = File.read(gemspec_file)
+ head, manifest, tail = spec.split(" # = MANIFEST =\n")
+
+ # replace name version and date
+ replace_header(head, :name)
+ replace_header(head, :version)
+ replace_header(head, :date)
+ #comment this out if your rubyforge_project has a different name
+ replace_header(head, :rubyforge_project)
+
+ # determine file list from git ls-files
+ files = `git ls-files`.
+ split("\n").
+ sort.
+ reject { |file| file =~ /^\./ }.
+ reject { |file| file =~ /^(rdoc|pkg)/ }.
+ map { |file| " #{file}" }.
+ join("\n")
+
+ # piece file back together and write
+ manifest = " s.files = %w[\n#{files}\n ]\n"
+ spec = [head, manifest, tail].join(" # = MANIFEST =\n")
+ File.open(gemspec_file, 'w') { |io| io.write(spec) }
+ puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+ libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+ unless libfiles.empty?
+ puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+ exit!
+ end
+ unless Dir['VERSION*'].empty?
+ puts "A `VERSION` file at root level violates Gem best practices."
+ exit!
+ end
+end
+
@@ -0,0 +1,43 @@
+require 'nokogiri'
+require 'faraday'
+
+class UrbanAPI
+ VERSION = "0.1.0"
+
+ class Definition < Struct.new(:definition, :example)
+ end
+
+ class << self
+ attr_accessor :urbandictionary_url
+ end
+ self.urbandictionary_url = "http://www.urbandictionary.com"
+
+ def self.define(*args)
+ new.define(*args)
+ end
+
+ def initialize(connection = Faraday.default_connection)
+ @conn = connection
+ @conn.url_prefix = self.class.urbandictionary_url
+ end
+
+ # http://www.urbandictionary.com/define.php?term=git&page=1
+ def define(word, options = {})
+ resp = @conn.get('define.php') do |req|
+ req.params['term'] = word
+ req.params['page'] = options[:page].to_i if options.key?(:page)
+ end
+ definitions_from_html Nokogiri::HTML(resp.body)
+ end
+
+ def definitions_from_html(doc)
+ defs = []
+ (doc / "table#entries tr").each do |row|
+ if defn = (row / 'div.definition').first
+ ex = (row / 'div.example').first
+ defs << Definition.new(defn.inner_html, ex ? ex.inner_html : nil)
+ end
+ end
+ defs
+ end
+end
@@ -0,0 +1,68 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+ s.specification_version = 2 if s.respond_to? :specification_version=
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+ s.rubygems_version = '1.3.5'
+
+ ## Leave these as is they will be modified for you by the rake gemspec task.
+ ## If your rubyforge_project name is different, then edit it and comment out
+ ## the sub! line in the Rakefile
+ s.name = 'NAME'
+ s.version = '0.0'
+ s.date = '2010-01-01'
+ s.rubyforge_project = 'NAME'
+
+ ## Make sure your summary is short. The description may be as long
+ ## as you like.
+ s.summary = "Quick Ruby library for scraping Urban Dictionary"
+ s.description = s.summary
+
+ ## List the primary authors. If there are a bunch of authors, it's probably
+ ## better to set the email to an email list or something. If you don't have
+ ## a custom homepage, consider using your GitHub URL or the like.
+ s.authors = ["Rick Olson"]
+ s.email = 'technoweenie@gmail.com'
+ s.homepage = 'http://github.com/technoweenie/urban_api'
+
+ ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+ ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+ s.require_paths = %w[lib]
+
+ ## This sections is only necessary if you have C extensions.
+ #s.require_paths << 'ext'
+ #s.extensions = %w[ext/extconf.rb]
+
+ ## If your gem includes any executables, list them here.
+ #s.executables = ["name"]
+ #s.default_executable = 'name'
+
+ ## Specify any RDoc options here. You'll want to add your README and
+ ## LICENSE files to the extra_rdoc_files list.
+ s.rdoc_options = ["--charset=UTF-8"]
+ s.extra_rdoc_files = %w[README LICENSE]
+
+ ## List your runtime dependencies here. Runtime dependencies are those
+ ## that are needed for an end user to actually USE your code.
+ s.add_dependency('nokogiri', ["~> 1.4.4"])
+ s.add_dependency('faraday', ["~> 0.5.6"])
+
+ ## List your development dependencies here. Development dependencies are
+ ## those that are only needed during development
+ #s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+ ## Leave this section as-is. It will be automatically generated from the
+ ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+ ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+ # = MANIFEST =
+ s.files = %w[]
+ # = MANIFEST =
+
+ ## Test files will be grabbed from the file list. Make sure the path glob
+ ## matches what you actually use.
+ s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

0 comments on commit 4521b5b

Please sign in to comment.