wolfram-alpha 0.2 → 0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00652f21bcb2490794e8336b9358369c1229251d
+  data.tar.gz: fe54230b01c9511646c62a9daea873de63d13dde
+SHA512:
+  metadata.gz: 3fdf8b6086f5ed6b3057425aaa6bc94ac9b0edc13fd21a31c75b55df983db14299b605763d1aac331481c15d7e059013f002bab290b1a3be137d5b5afed21371
+  data.tar.gz: ea2c7ec6cc2de5926d27d97863fb37aa29660bbbca258d33391f96e4a8fa7e5f7f37890f057ffc28a501a360528c020bf5713fc992829203cf97f07d9664d7af

data/library/wolfram-alpha.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 require 'cgi'
-require 'open-uri'
+require 'net/http'
 require 'nokogiri'
 
 require 'wolfram-alpha/pod'
@@ -16,8 +16,8 @@ require 'wolfram-alpha/response'
 # @author Mikkel Kroman
 module WolframAlpha
   # The current version of the WolframAlpha library.
-  Version = "0.2"
+  Version = "0.3"
 
   # The API request-uri.
-  RequestURI = "http://api.wolframalpha.com/v2/query?input=%s&appid=%s"
+  RequestURI = URI "http://api.wolframalpha.com/v2/query"
 end

data/library/wolfram-alpha/client.rb

@@ -1,10 +1,9 @@
 # encoding: utf-8
 
 module WolframAlpha
-  # Front object for communicating with the Wolfram|Alpha API.
   class Client
-    # The Wolfram|Alpha API developer key, which is set upon initialization.
-    attr_accessor :application_key
+    # The Wolfram|Alpha API application id, which is set upon initialization.
+    attr_accessor :token
 
     # The default options for a new client, it is merged with the options
     # set upon initialization.
@@ -14,23 +13,25 @@ module WolframAlpha
 
     # Initialize a new client to communicate with the Wolfram|Alpha API.
     #
-    # @param [String] application_key The developers API-key that can be easily
+    # @param [String] token The developers API-id that can be freely
     #   obtained from http://products.wolframalpha.com/api/
     # @param [Hash] options A set of options that may be put in the request.
     #
     # @see DefaultOptions
-    def initialize application_key = nil, options = {}
+    def initialize token, options = {}
+      @http = Net::HTTP.new RequestURI.host, RequestURI.port
+      @token = token or raise "Invalid token"
       @options = DefaultOptions.merge options
-      @application_key = application_key
     end
 
-    # Compute the value of user input, and return a new response.
+    # Compute the result of +input+, and return a new response.
     #
-    # @param [String] query The users input query.
+    # @param [String] input The input query.
     #
     # @return [Response] The parsed response object.
-    def compute query
-      document = Nokogiri::XML open request_url(query)
+    def query input
+      response = @http.get request_url(input)
+      document = Nokogiri::XML response.body
 
       if document.root.name == "queryresult"
         Response.new document
@@ -44,18 +45,15 @@ module WolframAlpha
     # Mash together the request url, this is where the request-uri is modified
     # according to the client options.
     #
-    # @param [String] query The users input query.
+    # @param [String] input The input query.
     #
     # @return [String] The complete, formatted uri.
-    def request_url query = nil
-      escaped_query = CGI.escape query
-      formatted_url = WolframAlpha::RequestURI % [escaped_query, @application_key]
+    def request_url input
+      query = { "appid" => @token, "input" => "#{input}" }.merge @options
 
-      if @options[:timeout]
-        formatted_url << "&timeout=#{@options[:timeout]}"
+      RequestURI.dup.tap do |this|
+        this.query = URI.encode_www_form query
       end
-
-      return formatted_url
     end
   end
 end

data/library/wolfram-alpha/pod.rb

@@ -3,19 +3,59 @@
 module WolframAlpha
   # A wrapper for the pod element.
   class Pod
-    # @return [Array] an array of sub-pods in this pod.
+    # @return [Array<Subpod>] an list of sub-pods in this pod.
     attr_reader :subpods
 
-    # Access an attribute on the pod element.
-    def [] attribute
-      @element[attribute]
-    end
-
     # Construct a new pod with an assigned element, then extract all subpods from it.
     def initialize element
       @element = element
 
-      @subpods = element.xpath("subpod").map { |element| Subpod.new self, element }
+      extract_subpods
+    end
+
+    # Returns whether the pod has any subpods.
+    def subpods?
+      @subpods and @subpods.any?
+    end
+
+    # Returns the pod id.
+    #
+    # @return [String] the pod id.
+    def id
+      @element["id"]
+    end
+
+    # Returns the pod title.
+    #
+    # @return [String] the pod title.
+    def title
+      @element["title"]
+    end
+
+    # Returns the pod scanner.
+    #
+    # @return [String] the pod scanner.
+    def scanner
+      @element["scanner"]
+    end
+
+    # Returns the pod position.
+    #
+    # @return [Fixnum] the pod position.
+    def position
+      @element["position"].to_i
+    end
+
+    # Inspect the pod.
+    def inspect
+      %{#<#{self.class.name} id: #{id.inspect} title: #{title.inspect} scanner: #{scanner.inspect} position: #{position.inspect} @subpods=#{@subpods.inspect}>}
+    end
+
+  private
+
+    # Extract the subpods.
+    def extract_subpods
+      @subpods = @element.css("subpod").map { |element| Subpod.new self, element }
     end
   end
 end

data/library/wolfram-alpha/response.rb

@@ -3,45 +3,28 @@
 module WolframAlpha
   # This is a response object that wraps the response data in a
   # easily managable object.
-  #
-  # @see #input_as_text
-  # @see #result_as_text
   class Response
+    include Enumerable
     attr_reader :pods
 
     # Construct a new response for a +document+.
-    def initialize document = nil
-      @document = document
-
-      @pods = @document.xpath("//pod").map {|element| Pod.new element }
-    end
-
-    # Return the pod containing the subpods which is of type +input+.
-    def input
-      find_pod_with_id "Input"
-    end
-
-    # Map and join the input interpreted pod's subpods as a printable string.
-    def input_as_text
-      input.subpods.map(&:text).join ', '
-    end
-
-    # Return the pod containing the subpods which is of type +result+.
-    def result
-      find_pod_with_id "Result"
+    def initialize document
+      @pods = document.css("pod").map { |element| Pod.new element }
     end
 
-    # Map and join the result pod's subpods as a printable string.
-    def result_as_text
-      result.subpods.map(&:text).join ', '
+    # Return the first occurence of a pod with the id of +id+.
+    def [] id
+      find { |pod| pod.id == id }
     end
 
-  private
+    # Calls the given block once for each element in self, passing that element as a parameter.
+    #
+    # An Enumerator is returned if no block is given.
+    def each
+      return @pods.to_enum unless block_given?
 
-    # Find a pod of which id is +id+.
-    def find_pod_with_id id
-      @pods.find do |pod|
-        pod["id"] == id
+      @pods.each do |pod|
+        yield pod
       end
     end
   end

data/library/wolfram-alpha/subpod.rb

@@ -1,25 +1,28 @@
-# encoding: utf-8
-
-module WolframAlpha
-  # A subpod is a container for a type of output, such as plain text,
-  # numbers, images, etc.
-  class Subpod
-    # This is the pod that this subpod belongs to.
-    attr_accessor :pod
-
-    # Construct a new subpod.
-    def initialize pod, element
-      @pod, @element = pod, element
-    end
-
-    # Access an attribute on the subpod element.
-    def [] key
-      return @element[key]
-    end
-
-    # Get the contents of plaintext as plain text.
-    def text
-      @element.xpath("plaintext").text
-    end
-  end
-end
+# encoding: utf-8
+
+module WolframAlpha
+  class Subpod
+    # Construct a new pod with an assigned element.
+    def initialize parent, element
+      @parent = parent
+      @element = element
+    end
+
+    # Returns whether the subpod contains a plaintext element.
+    def plaintext?
+      not plaintext.nil?
+    end
+
+    # Returns the plaintext element as text.
+    #
+    # @return [String] the plain text.
+    def plaintext
+      @plaintext ||= @element.at_css("plaintext").text
+    end
+
+    # Inspect the subpod.
+    def inspect
+      %{#<#{self.class.name} plaintext: #{plaintext.inspect}>}
+    end
+  end
+end

metadata

@@ -1,61 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: wolfram-alpha
 version: !ruby/object:Gem::Version
-  version: '0.2'
-  prerelease: 
+  version: '0.3'
 platform: ruby
 authors:
 - Mikkel Kroman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-22 00:00:00.000000000 Z
+date: 2013-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &22778340 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22778340
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
-email: mk@maero.dk
+email: mk@uplink.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- library/wolfram-alpha.rb
 - library/wolfram-alpha/client.rb
 - library/wolfram-alpha/pod.rb
 - library/wolfram-alpha/response.rb
 - library/wolfram-alpha/subpod.rb
-homepage: 
-licenses: []
+- library/wolfram-alpha.rb
+homepage: https://github.com/mkroman/wolfram-alpha
+licenses:
+- Internet Systems Consortium (ISC)
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - library
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Wolfram|Alpha introduces a fundamentally new way to get knowledge and answers
   — not by searching the web, but by doing dynamic computations based on a vast collection
   of built-in data, algorithms, and methods.