ldoce 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Burns
+
+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,38 @@
+# Ldoce
+Easily interface with the Longman Dictionary of Contemporary English API from Ruby:
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ldoce'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ldoce
+
+## Usage
+
+```ruby
+Ldoce::Word.api_key = "<your_key>"
+
+cat = Ldoce::Word.search 'cat'
+cat.play #plays mp3 sample - only working for Mac at the moment
+cat.definition
+#=> "A small four legged animal commonly kept as a pet"
+
+Ldoce::Word.play 'cat'
+#=> <Ldoce::Word: cat "A small four legged animal commonly kept as a pet">
+```
+
+## 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/ldoce.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ldoce/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mark Burns"]
+  gem.email         = ["markthedeveloper@gmail.com"]
+  gem.description   = %q{API for the Longman Dictionary of Contemporary English}
+  gem.summary       = %q{So far covers playing mp3 media files and fetching definitions}
+  gem.homepage      = "https://github.com/markburns/ldoce"
+
+  gem.add_dependency 'httparty'
+
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "ldoce"
+  gem.require_paths = ["lib"]
+  gem.version       = Ldoce::VERSION
+end

data/lib/ldoce.rb

@@ -0,0 +1,6 @@
+require "httparty"
+require "ldoce/version"
+require "ldoce/word"
+
+module Ldoce
+end

data/lib/ldoce/version.rb

@@ -0,0 +1,3 @@
+module Ldoce
+  VERSION = "0.0.1"
+end

data/lib/ldoce/word.rb

@@ -0,0 +1,122 @@
+module Ldoce
+  class Word
+    include HTTParty
+
+    attr_reader :query, :response
+
+    def initialize query, response
+      @query, @response  = query, response
+    end
+
+    def word
+      query
+    end
+
+    def play
+      if mp3?
+        unless File.exists? filename
+          command = "curl #{mp3_url} -silent > #{filename}"
+          `#{command}`
+        end
+        `afplay #{filename}`
+      end
+      self
+    end
+
+    def mp3?
+      !!mp3_url
+    end
+
+    def entries
+      entries = response["Entries"]
+      entries = entries["Entry"] rescue []
+      arrayify entries
+    end
+
+    def definition
+      definitions = each_in entries  do |entry|
+        each_in entry["Sense"] do |f|
+          if f["DEF"]
+            f["DEF"]["#text"]
+          elsif f["Subsense"]
+            each_in f["Subsense"] do |g|
+              g["DEF"]["#text"]
+            end
+          end
+        end
+      end.flatten.compact
+
+      definitions.map { |e| "\"#{e}\"" }.join(",")
+    end
+
+    def inspect
+      "<Word #{@query}: #{definition} mp3:#{mp3?}>"
+    end
+
+    def american_pronunciations
+      entries.map{|e| ["multimedia"].detect{|w| w["@type"]=="US_PRON"}["@href"]}
+    end
+
+    def british_pronunciations
+      entries.map{|e| e["multimedia"].detect{|w| w["@type"]=="GB_PRON"}["@href"]}
+    end
+
+    def mp3_url
+      pronunciation = british_pronunciations.first || american_pronunciations.first
+      url = "https://api.pearson.com/longman/dictionary#{pronunciation}?apikey=#{Word.api_key}"
+    rescue
+      nil
+    end
+
+    private
+
+    def arrayify hash_or_array
+      hash_or_array.is_a?(Hash) ? [hash_or_array] : hash_or_array
+    end
+
+    def each_in hash_or_array
+      arrayify(hash_or_array).map do |el|
+        yield el
+      end
+    end
+
+    def filename lang="british"
+      "tmp/#{lang}_#{query}.mp3"
+    end
+
+    class MissingApiKey < Exception; end
+    class << self
+      def play query
+        search(query).play
+      end
+
+      def find query
+        search query
+      end
+
+      def search query
+        response = get(url(query)).parsed_response
+        Word.new query, response
+      end
+
+      attr_writer :api_key
+
+      def api_key
+        @api_key ||= YAML.load(File.read "api_key.yml")["api_key"]
+      rescue
+        raise MissingApiKey.new "Either set the API key programmatically:
+Ldoce::Word.api_key = '<your_key>'
+
+or
+
+Create a file called api_key.yml and add your Longman API Key:
+api_key: <your_key_here>"
+      end
+
+      def url query
+        "https://api.pearson.com/longman/dictionary/entry.json?q=#{query}&apikey=#{api_key}"
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: ldoce
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mark Burns
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70120811014960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70120811014960
+description: API for the Longman Dictionary of Contemporary English
+email:
+- markthedeveloper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ldoce.gemspec
+- lib/ldoce.rb
+- lib/ldoce/version.rb
+- lib/ldoce/word.rb
+homepage: https://github.com/markburns/ldoce
+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.15
+signing_key: 
+specification_version: 3
+summary: So far covers playing mp3 media files and fetching definitions
+test_files: []