saper 0.5.1 → 0.5.2

data/lib/saper/core/browser.rb

@@ -10,13 +10,26 @@ module Saper
     # Approximate number of bytes sent.
     attr_reader :sent
     
+    AGENTS = {
+      :ie6     => 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)',
+      :ie7     => 'Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; .NET CLR 1.1.4322; .NET CLR 2.0.50727)',
+      :ie8     => 'Mozilla/5.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; .NET CLR 1.1.4322; .NET CLR 2.0.50727)',
+      :ie9     => 'Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0)',
+      :mozilla => 'Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.4b) Gecko/20030516 Mozilla Firebird/0.6',
+      :safari  => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_2) AppleWebKit/534.51.22 (KHTML, like Gecko) Version/5.1.1 Safari/534.51.22',
+      :iphone  => 'Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420+ (KHTML, like Gecko) Version/3.0 Mobile/1C28 Safari/419.3',
+      :ipad    => 'Mozilla/5.0 (iPad; U; CPU OS 3_2 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Version/4.0.4 Mobile/7B334b Safari/531.21.10',
+      :android => 'Mozilla/5.0 (Linux; U; Android 3.0; en-us; Xoom Build/HRI39) AppleWebKit/534.13 (KHTML, like Gecko) Version/4.0 Safari/534.13',
+      :saper   => 'Mozilla/5.0 (compatible; Saper Ruby client %s)' % Saper::VERSION
+    }
+    
     # Returns a new Browser instance.
     # @option options [Symbol] :agent User agent
     # @option options [Hash] :headers Additional request headers
     # @option options [Logger] :logger Logger instance
     # @return [Saper::Browser]
     def initialize(options = {})
-      @agent    = options.delete(:agent)
+      @agent    = options.delete(:agent) || :saper
       @headers  = options.delete(:headers)
       @logger   = options.delete(:logger) || Saper::Logger.new
       @history  = []
@@ -61,46 +74,34 @@ module Saper
       @logger.download(url)
       @history.push url
       data = @mech.get(url, query)
-      Saper::Items::Document.new data
+      Saper::Items::Document.new data.body, data.uri, data.header
+    rescue Mechanize::ResponseCodeError
+      Saper::Items::Nothing.new # TODO: change to custom exception
     end
     
     # Performs a POST request and returns Saper::Document.
     # @param url [String] URL to request
     # @param query [Hash] payload
     # @return [Saper::Document]
-    def post(url, query = {})
+    def post(url, query = {}, headers = {})
       @logger.download(url)
       @history.push url
-      data = @mech.post(url, query)
-      Saper::Items::Document.new data
+      data = @mech.post(url, query, headers)
+      Saper::Items::Document.new data.body, data.uri, data.header
+    rescue Mechanize::ResponseCodeError
+      Saper::Items::Nothing.new # TODO: change to custom exception
+    end
+    
+    # @todo
+    def post_with_bearer_token(url, query, token)
+      post(url, query, { "Authorization" => "Bearer %s" % token })
     end
     
     # Returns User-Agent string used with requests.
     # @return [String]
     def agent
-      case @agent
-      when :ie6
-        'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)'
-      when :ie7
-        'Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; .NET CLR 1.1.4322; .NET CLR 2.0.50727)'
-      when :ie8
-        'Mozilla/5.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; .NET CLR 1.1.4322; .NET CLR 2.0.50727)'
-      when :ie9
-        'Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0)'
-      when :mozilla
-        'Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.4b) Gecko/20030516 Mozilla Firebird/0.6'
-      when :safari
-        'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_2) AppleWebKit/534.51.22 (KHTML, like Gecko) Version/5.1.1 Safari/534.51.22'
-      when :iphone
-        'Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420+ (KHTML, like Gecko) Version/3.0 Mobile/1C28 Safari/419.3'
-      when :ipad
-        'Mozilla/5.0 (iPad; U; CPU OS 3_2 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Version/4.0.4 Mobile/7B334b Safari/531.21.10'
-      when :android
-        'Mozilla/5.0 (Linux; U; Android 3.0; en-us; Xoom Build/HRI39) AppleWebKit/534.13 (KHTML, like Gecko) Version/4.0 Safari/534.13'
-      else
-        'Mozilla/5.0 (compatible; Saper Ruby client %s)' % Saper::VERSION
-      end
+      AGENTS[@agent.to_sym] || @agent.to_s
     end
-  
+    
   end
 end

data/lib/saper/core/dsl.rb

@@ -16,26 +16,21 @@ module Saper
     # A mixin module with a set of parsing methods
     module Methods
       
+      # @todo
       def namespace
         @namespace ||= Saper::Namespace.new
       end
       
+      # @todo
       def recipe(id, name = nil, &block)
-        namespace[id] = Recipe.parse(id, name, :namespace => namespace, &block)
+        namespace[id] = Recipe.parse(id, name, namespace, &block)
       end
       
+      # @todo
       def [](name)
         namespace[name]
       end
       
-      def run_by_default(*args)
-        namespace.run_by_default(*args)
-      end
-      
-      def run(*args)
-        namespace.run(*args)
-      end
-      
     end
     
     class Recipe
@@ -45,9 +40,9 @@ module Saper
       # `#to_recipe`).
       # @param id [Symbol] recipe ID
       # @return [Saper::Recipe, Saper::DSL::Recipe]
-      def self.parse(id, name = nil, options = {}, &block)
-        instance = self.new(id, options.merge(:name => name), &block)
-        if options[:namespace].is_a?(Namespace)
+      def self.parse(id = nil, name = nil, ns = nil, &block)
+        instance = self.new(id, name, ns, &block)
+        if ns.is_a?(Namespace)
           instance
         else
           instance.to_recipe
@@ -56,16 +51,19 @@ module Saper
       
       attr_reader :recipe
       
-      def initialize(id = nil, options = {}, &block)
-        @recipe, @block = Saper::Recipe.new(id, options), block
+      # @todo
+      def initialize(id, name = nil, ns = nil, &block)
+        @recipe, @ns, @block = Saper::Recipe.new(id, :name => name), ns, block
       end
       
-      def to_recipe
+      # @todo
+      def to_recipe(*args)
         self.instance_eval(&@block) if recipe.empty?; recipe
       end
       
+      # @todo
       def method_missing(name, *args, &block)
-        @recipe << Saper::Action.new(name, *args, :namespace => @recipe.namespace, &block)
+        @recipe << Saper::Action.new(name, *args, :namespace => @ns, &block)
       end
       
     end

data/lib/saper/core/error.rb

@@ -9,7 +9,7 @@ module Saper
   # NoAction is raised whenever an implementation of Saper::Action is not found.
   class ActionNotFound < Error; end
   
-  # NamespaceMissing is raised whenever Saper::Runtime requires a missing namespace.
+  # NamespaceMissing is raised whenever Saper::Action requires a missing namespace.
   class NamespaceMissing < Error; end
   
   # NoAction is raised whenever an unsupported object is added to Saper::Recipe.

data/lib/saper/core/item.rb

@@ -1,7 +1,7 @@
 module Saper
   class Item
     
-    # Tracks subclasses of Saper::Argument.
+    # Tracks subclasses of Saper::Item.
     # @return [Class]
     def self.inherited(base)
       subclasses[base.type] = base
@@ -66,7 +66,7 @@ module Saper
       self.class.type.to_sym
     end
     
-    #
+    # @todo
     def serialize
       to_native
     end

data/lib/saper/core/keychain.rb

@@ -1,18 +1,71 @@
 module Saper
   class Keychain
-  
+    
+    # @todo
+    def self.load(path)
+      case File.extname(path)
+      when '.yaml'
+        load_yaml(path)
+      when '.yml'
+        load_yaml(path)
+      when '.json'
+        load_json(path)
+      else
+        nil
+      end
+    end
+    
+    # @todo
+    def self.load_yaml(path)
+      new YAML.load_file(path)
+    rescue
+      nil
+    end
+    
+    # @todo
+    def self.load_json(path)
+      new JSON.parse(IO.read(path), :symbolize_names => true)
+    rescue
+      nil
+    end
+    
     # Returns a new keychain instance
     # @return [Saper::Keychain]
-    def initialize
-      # TODO: not yet implemented
+    def initialize(services = {})
+      @services = Hash[services.map { |k,v| [k.to_s, v] }]
     end
     
     # Returns access credentials for the specified service.
     # @param service [String, Symbol] service name
     # @return [Hash, nil]
     def [](service)
-      # TODO: not yet implemented
+      @services[service.to_s] || {}
+    end
+    
+    # @todo
+    def login(service)
+      self[service][:login]
+    end
+    
+    # @todo
+    def password(service)
+      self[service][:password]
+    end
+    
+    # @todo
+    def token(service)
+      self[service][:token]
+    end
+    
+    # @todo
+    def has?(service)
+      !self[service].empty?
+    end
+    
+    # @todo
+    def services
+      @services.keys.select { |service| has?(service) }
     end
     
   end
-end
+end

data/lib/saper/core/namespace.rb

@@ -5,14 +5,14 @@ module Saper
   # @param recipe [Symbol] recipe name
   # @param input [Object] input for recipe
   # @return [Saper::Runtime]
-  def self.run(file, recipe, input = nil)
-    load(file).run(recipe, input)
+  def self.run_from_file(file, recipe, input, opts = {})
+    load(file).run(recipe, input, opts)
   end
   
   # Parses recipes saved in a file.
   # @param file [String] file name
   # @return [Saper::Namespace]
-  def self.load(file)
+  def self.load(path)
     Namespace.parse File.read(path)
   end
   
@@ -64,18 +64,13 @@ module Saper
       end
     end
     
-    # @todo
-    def run_by_default(symbol = nil)
-      @default ||= symbol
-    end
-    
     # Runs an recipe and returns resulting Saper:Runtime.
     # @param input [Object]
     # @param name [String, Symbol] action name
     # @param options [Hash] options for Runtime instance
     # @return [Saper::Runtime]
     def run(name = nil, input = nil, options ={})
-      self[name].run(input, options.merge(:namespace => self))
+      self[name].run(input, options)
     end
     
     # Returns recipe with specified ID or fails silently if not found.
@@ -93,17 +88,19 @@ module Saper
     # @param id [String, Symbol] recipe ID
     # @return [Saper::Recipe]
     def [](id)
-      if @recipes.key?(id.to_s)
-        value = @recipes[id.to_s]
-        if value.is_a?(Recipe)
-          return value
-        end
-        if value.respond_to?(:to_recipe)
-          return @recipes[id.to_s] = value.to_recipe
-        end
+      id = id.to_s
+      if @recipes.key?(id)
+        value = @recipes[id]
       else
-        find(id)
+        value = find(id)
       end
+      if value.is_a?(Recipe)
+        return value
+      end
+      if value.respond_to?(:to_recipe)
+        return @recipes[id] = value.to_recipe
+      end
+      raise RecipeNotFound, id
     end
     
     # Caches recipe instance.

data/lib/saper/core/recipe.rb

@@ -11,7 +11,7 @@ module Saper
       unless data.is_a?(Hash)
         raise(InvalidRecipe, data)
       end
-      new(data[:id], :name => data[:name], :namespace => namespace) do |recipe|
+      new(data[:id], :name => data[:name]) do |recipe|
         unless data[:actions].nil?
           recipe.push *Action.unserialize(data[:actions], namespace)
         end
@@ -52,12 +52,6 @@ module Saper
       @options[:name].nil? ? nil : @options[:name].to_s
     end
     
-    # Returns Saper::Namespace instance.
-    # @return [Namespace]
-    def namespace
-      @options[:namespace].is_a?(Namespace) ? @options[:namespace] : nil
-    end
-    
     # Returns a list of data types required as input.
     # @return [Array<Symbol>]
     def input_required
@@ -92,12 +86,17 @@ module Saper
       self
     end
     
-    # Runs recipe and returns Runtime instance.
+    # Runs recipe and returns Result instance.
     # @param input [object] input for the first action
-    # @param options [Hash] options for Runtime object
-    # @return [Saper::Runtime]
-    def run(input = nil, options = {})
-      Runtime.new(actions, input, { :namespace => namespace }.merge(options))
+    # @param runtime [Runtime, Hash] Runtime instance or options for a new one 
+    # @return [Saper::Result]
+    def run(input = nil, runtime = nil)
+      unless runtime.is_a?(Runtime)
+        runtime = Runtime.new({}, runtime || {})
+      end
+      stack = Stack.new(runtime, input)
+      enum  = enum_for(:each_stack, stack)
+      Result.new(enum.to_a)
     end
     
     # Returns `true` if recipe contains no actions.
@@ -130,5 +129,47 @@ module Saper
       serialize.to_json(*args)
     end
     
+    private
+    
+    # Yields resulting Stack instances.
+    # @param stack [Saper::Stack]
+    # @param index [Integer] action undex
+    # @yield [Saper::Stack]
+    # @return [nil]
+    def each_stack(stack, index = 0, &block)
+      if stack.error?
+        yield stack
+        return nil
+      end
+      if index >= actions.size
+        yield stack
+        return nil
+      end
+      each_action_result(stack, actions[index]) do |stack|
+        each_stack(stack, index + 1, &block)
+      end
+      nil
+    end
+    
+    # Yields action results one-by-one.
+    # @param stack [Saper::Stack]
+    # @param action [Saper::Action]
+    # @yield [Saper::Item]
+    # @return [nil]
+    def each_action_result(stack, action)
+      begin
+        results = action.run(stack.last, stack.runtime)
+      rescue Saper::Error => error
+        results = error
+      end
+      unless results.is_a?(Array)
+        yield stack.add(results); return nil
+      end
+      results.each do |result|
+        yield stack.copy.add(result)
+      end
+      nil
+    end
+    
   end
 end

data/lib/saper/core/result.rb

@@ -0,0 +1,72 @@
+module Saper
+  class Result
+    
+    # @todo
+    attr_reader :stacks
+    
+    # @todo
+    def initialize(stacks = [])
+      @stacks = stacks.to_a
+      if block_given?
+        yield self
+      end
+    end
+    
+    # @todo
+    def success?
+      not failure?
+    end
+    
+    # @todo
+    def failure?
+      stacks.all?(&:error?)
+    end
+    
+    # @todo
+    def size
+      stacks.size
+    end
+    
+    # @todo
+    def multiple?
+      size > 1
+    end
+    
+    # @todo
+    def to_saper_array
+      stacks.map(&:result)
+    end
+    
+    # @todo
+    def to_native_array
+      to_saper_array.map(&:to_native)
+    end
+    
+    # @todo
+    def to_serialized_array
+      to_saper_array.map(&:serialize)
+    end
+    
+    # @todo
+    def to_saper
+      multiple? ? to_saper_array : to_saper_array.first
+    end
+    
+    # @todo
+    def to_native
+      multiple? ? to_native_array : to_native_array.first
+    end
+    
+    # @todo
+    def serialize
+      multiple? ? to_serialized_array : to_serialized_array.first
+    end
+    
+    # Returns runtime results as JSON.
+    # @return [Array]
+    def to_json(*args)
+      JSON.dump(serialize)
+    end
+    
+  end
+end