skyscanner 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: afa3e386540526da0ca3cc32b865324308da8281
+  data.tar.gz: 5fd2a877d72e668e0750eb401cb1cd8717841bcc
+SHA512:
+  metadata.gz: d19e4b0748824b1157964e7c7407e47280459478b8a4546d87072d3a1c3fc2486ff53192e4f1f34ca5c7eef7f99fd7f159ca42edb913c81dbd27f201cc2413be
+  data.tar.gz: d5251bc5c84755f3b5064da6eaaad76dae1f2bfc7195a6f47e006b363570ccd324ee6b48250057af91797d451b77731ac03d2e481a85d9c7fb12a8f98f6bf831

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2012 Dan Matthews / Ticket Evolution (http://ticketevolution.com)
+Copyright (c) 2013 Alex Beregszaszi
+
+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,68 @@
+skyscanner
+==========
+
+A Ruby wrapper for the Skyscanner API.
+
+
+Installation
+------------
+
+**With Bundler**
+
+In your Gemfile, add the following line
+
+    gem 'skyscanner', :require => 'skyscanner'
+
+**Without Bundler**
+
+    gem install skyscanner
+
+Usage
+-----
+
+At the moment the interface is very simple and it only supports the Browse Cache Service API. Feel free to submit pull requests for more features.
+
+Each of the four endpoints can be accessed with a class method reflecting the endpoint's name.
+
+    Skyscanner::Connection.browse_dates
+    Skyscanner::Connection.browse_grid
+    Skyscanner::Connection.browse_routes
+    Skyscanner::Connection.browse_quotes
+    Skyscanner::Connection.site_redirect
+
+Options can be passed in a hash to these methods and they will be included in the request.
+
+    ## Example from: http://www.skyscanneraffiliate.net/portal/en-GB/US/BrowseCache/BrowseQuotes
+    Skyscanner::Conneciton.browse_quotes({ :country => "GB", :curency => "GBP", :locale => "en-GB", :originPlace => "UK", :destinationPlace => "anywhere", :outboundPartialDate => "anytime", :inboundPartialDate => "anytime" })
+    # => GET http://partners.api.skyscanner.net/apiservices/browsequotes/v1.0/GB/GBP/en-GB/UK/anywhere/anytime/anytime?apiKey=prtl6749387986743898559646983194
+
+There are a number of class level options that can be overridden.
+
+    Skyscanner::Connection.adapter          # the Faraday adapter to use (default: :net_http)
+    Skyscanner::Connection.logger           # a Logger object for logging requests (default: nil)
+    Skyscanner::Connection.protocol         # http or https (default: :http)
+    Skyscanner::Connection.response_format  # ruby, json, jsonp or xml (default: ruby)
+    Skyscanner::Connection.url              # partners.api.skyscanner.net/apiservices/
+    Skyscanner::Connection.version          # v.10
+    
+Example:
+
+    Skyscanner::Connection.protocol
+    # => :http
+    Skyscanner::Connection.protocol = :https
+    # => :https
+
+These options can also be overridden during instantiation of a Skyscanner::Connection
+
+    @secure = Skyscanner::Connection.new({:protocol => :https})
+
+
+Copyright
+---------
+
+Made for Soundtravel (http://soundtravel.co/).
+
+Copyright (c) 2013 Alex Beregszaszi. See LICENSE for details.
+
+Based on the SeatGeek Ruby API (https://github.com/bluefocus/seatgeek/) which is:
+Copyright (c) 2012 Dan Matthews / Ticket Evolution ([http://ticketevolution.com](http://ticketevolution.com))

data/lib/skyscanner.rb

@@ -0,0 +1,214 @@
+require 'faraday'
+require 'multi_json'
+
+module Skyscanner
+  class Connection
+    class << self; self; end.class_eval do
+      def adapter; @@adapter ||= :net_http; end
+      def adapter=(input); @@adapter = input; end
+
+      def site_redirect(*args); new.site_redirect(*args); end
+      def browse_quotes(*args); new.browse_quotes(*args); end
+      def browse_grid(*args); new.browse_grid(*args); end
+      def browse_routes(*args); new.browse_routes(*args); end
+      def browse_dates(*args); new.browse_dates(*args); end
+
+      def events(*args); new.events(*args); end
+
+      def logger; @@logger ||= nil; end
+      def logger=(input); @@logger = input; end
+
+      def options
+        {
+          :adapter => adapter,
+          :logger => logger,
+          :protocol => protocol,
+          :response_format => response_format,
+          :url => url,
+          :version => version,
+          :api_key => apikey
+        }
+      end
+
+      def performers(*args); new.performers(*args); end
+
+      def protocol; @@protocol ||= :http; end
+      def protocol=(input); @@protocol = input; end
+
+      def response_format; @@response_format ||= :ruby; end
+      def response_format=(input); @@response_format = input; end
+
+      def taxonomies(*args); new.taxonomies(*args); end
+
+      def url; @@url ||= "partners.api.skyscanner.net/apiservices"; end
+      def url=(input); @@url = input; end
+
+      def venues(*args); new.venues(*args); end
+
+      def version; @@version ||= "v1.0"; end
+      def version=(input); @@version = input; end
+
+      def apikey; @@api_key end
+      def apikey=(input); @@api_key = input; end
+    end
+
+    def initialize(options = {})
+      @options = self.class.options.merge({}.tap do |opts|
+        options.each do |k, v|
+          opts[k.to_sym] = v
+        end
+      end)
+    end
+
+    def handle_response(response)
+      if response_format == :ruby and response.status == 200
+        MultiJson.decode(response.body)
+      else
+        { :status => response.status, :body => response.body }
+      end
+    end
+
+    # Ruby 1.8.7 / ree compatibility
+    def id
+      @options[:id]
+    end
+
+    def request(url, segments, params)
+      handle_response(Faraday.new(*builder(url, segments_to_path(segments, params), params.clone)) do |build|
+        build.adapter adapter
+        #        build.use Faraday::Response::VerboseLogger, logger unless logger.nil?
+      end.get)
+    end
+
+    def response_format
+      @options[:response_format].to_sym
+    end
+
+    def api_key
+      @options[:api_key]
+    end
+
+    def segments_to_path(segments, params)
+      out = []
+      segments.each do |k, v|
+        value = params[k]
+        if value then
+          out << value
+        elsif v then
+          raise ArgumentError.new("Mandatory parameter (#{k}) missing")
+        end
+      end
+      out.join('/')
+    end
+
+    def site_redirect(params = {})
+      segments = {
+        :country => true,
+        :currency => true,
+        :locale => true,
+        :originPlace => true,
+        :destinationPlace => true,
+        :outboundPartialDate => true,
+        :inboundPartialDate => false,
+        :associateID => false,
+        :utm_source => false,
+        :utm_medium => false,
+        :utm_name => false
+      }
+
+#      request('skyscannerredirect', segments, params)
+      # Life isn't that easy - in this case the constructed URL is what we return
+      ret = builder("skyscannerredirect", segments_to_path(segments, params), params.clone)
+      "#{ret[0]}?apiKey=#{api_key}"
+    end
+
+    def browse_quotes(params = {})
+      segments = {
+        :country => true,
+        :currency => true,
+        :locale => true,
+        :originPlace => true,
+        :destinationPlace => true,
+        :outboundPartialDate => true,
+        :inboundPartialDate => false
+      }
+      request('browsequotes', segments, params)
+    end
+
+    def browse_grid(params = {})
+      segments = {
+        :country => true,
+        :currency => true,
+        :locale => true,
+        :originPlace => true,
+        :destinationPlace => true,
+        :outboundPartialDate => true,
+        :inboundPartialDate => false
+      }
+      request('browsegrid', segments, params)
+    end
+
+    def browse_routes(params = {})
+      segments = {
+        :country => true,
+        :currency => true,
+        :locale => true,
+        :originPlace => true,
+        :destinationPlace => true,
+        :outboundPartialDate => true,
+        :inboundPartialDate => false
+      }
+      request('browseroutes', segments, params)
+    end
+
+    def browse_dates(params = {})
+      segments = {
+        :country => true,
+        :currency => true,
+        :locale => true,
+        :originPlace => true,
+        :destinationPlace => true,
+        :outboundPartialDate => true,
+        :inboundPartialDate => false
+      }
+      request('browsedates', segments, params)
+    end
+
+    def endpoint_uri(method)
+      "#{protocol}://#{url}/#{method}/#{version}/"
+    end
+
+    def uri(path)
+      "#{protocol}://#{url}/#{path}/#{version}"
+    end
+
+    private
+
+    def method_missing(method, *params)
+      @options.keys.include?(method.to_sym) && params.first.nil? ? @options[method.to_sym] : super
+    end
+
+    def builder(uri_segment, path, params)
+      return [
+        [].tap do |part|
+          part << endpoint_uri(uri_segment)
+          part << path
+          part << "/#{params.delete(:id)}" unless params[:id].nil?
+        end.join,
+        {
+          :params => custom_options.merge(([:jsonp, :xml].include?(response_format) ? \
+          params.merge(:format => response_format) : params)).merge(:apiKey => api_key)
+        }
+      ]
+    end
+
+    def custom_options
+      @custom_options ||= {}.tap do |opts|
+        ignore = self.class.options.keys
+        @options.each do |k, v|
+          opts[k] = v unless ignore.include?(k)
+        end
+      end
+    end
+  end
+end

data/skyscanner.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name        = "skyscanner"
+  gem.version     = "0.1"
+  gem.authors     = ["Alex Beregszaszi"]
+  gem.email       = ["alex@rtfs.hu"]
+  gem.description = "A Ruby wrapper for the Skyscanner API. See http://www.skyscanneraffiliate.net/portal/en-GB/US/api/overview for the official documentation."
+  gem.summary     = "A Ruby wrapper for the Skyscanner API."
+  gem.homepage    = "http://github.com/axic/skyscanner"
+  gem.license     = "MIT"
+
+  gem.add_dependency "faraday"
+  gem.add_dependency "multi_json"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: skyscanner
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Alex Beregszaszi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby wrapper for the Skyscanner API. See http://www.skyscanneraffiliate.net/portal/en-GB/US/api/overview
+  for the official documentation.
+email:
+- alex@rtfs.hu
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .gitignore
+- LICENSE
+- README.md
+- lib/skyscanner.rb
+- skyscanner.gemspec
+homepage: http://github.com/axic/skyscanner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Skyscanner API.
+test_files: []