xignite 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Nate Clark
+
+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,99 @@
+[![Build Status](https://secure.travis-ci.org/heythisisnate/xignite.png)](http://travis-ci.org/heythisisnate/xignite)
+
+### Xignite Ruby
+
+Xignite is a Ruby client library for the [Xignite Web Services API](http://xignite.com)
+
+This gem only supports a subset of Xignite's Web Services. **Currently Supported** are all operations under:
+
+  * [Currencies](http://www.xignite.com/xCurrencies.asmx)
+  * [Metals](http://www.xignite.com/xMetals.asmx)
+
+## Installation ##
+
+    gem install xignite
+    require 'xignite'
+
+with Bundler, simply:
+
+    gem 'xignite'
+
+## Basic Usage ##
+
+  *Xignite Ruby* provides a rubyist's interface to the Xignite API. It constructs a GET or POST request for you, and then parses the response into Array and Hash-like Ruby objects. Reference the Xignite documentation for required parameters and options, and call the appropriate Web Service in one of two ways:
+
+    # The following two statements do the same thing
+    response = Xignite::Metals.get_last_real_time_metal_quote(
+      'Type' => 'XAU', 'Currency' => 'USD'
+    )
+
+    response = Xignite::Metals::GetLastRealTimeMetalQuote(
+      'Type' => 'XAU', 'Currency' => 'USD'
+    )
+
+  The response is a `Xignite::Metals::GetLastRealTimeMetalQuote` object:
+
+    #<Xignite::Metals::GetLastRealTimeMetalQuote:0x007fbbc3a648f8
+      @metal_quote={
+        "outcome"=>"Success",
+        "identity"=>"Request",
+        "delay"=>0.006,
+        "symbol"=>"XAUUSDO",
+        "type"=>"XAU",
+        "currency"=>"USD",
+        "date"=>#<Date: 2011-12-09 (4911809/2,0,2299161)>,
+        "time"=>2011-12-09 22:59:52 UTC,
+        "rate"=>1711.42498779,
+        "bid"=>1710.69995117,
+        "bid_time"=>2011-12-09
+        22:59:52 UTC,
+        "ask"=>1712.15002441,
+        "ask_time"=>2011-12-09 22:59:52 UTC
+      }>
+
+    response.metal_quote['ask']
+    # => 1712.15002441
+
+    response.metal_quote['time']
+    # => 2011-12-09 22:59:52 UTC
+
+## Configuration ##
+
+    Xignite.configure do |config|
+
+      # Configure which HTTP method is used to contact the Xignite service
+      # Default: :get, Possible values: [ :get, :post ]
+      #
+      self.request_method = :get
+
+      # Configure the endpoint hostname
+      # Default: www.xignite.com
+      #
+      self.endpoint = Xignite::URL
+
+      # Use HTTPS
+      # Default: false
+      #
+      self.https = true
+
+      # Set your Xignite username. This automatically adds a 'Header_Username' parameter to all requests
+      # Default: nil
+      #
+      self.username = 'goldbug'
+
+    end
+
+## Contributing ##
+
+To add support for additional web services or features, simply extend from the `Xignite::Service`. Pull requests are encouraged and will be considered promptly.
+
+[Issues/Requests](https://github.com/heythisisnate/xignite/issues)
+
+## In the Wild ##
+
+Xignite Ruby was originally written and maintained for [GoldBug](http://goldbugapp.com) app. Issue a pull request or let us know if you'd like your site/company link added here.
+
+## Disclaimer ##
+
+The author of this software is not affiliated with Xignite and cannot provide support for Xignite products and services.
+Please read the [MIT LICENSE](https://github.com/heythisisnate/xignite/blob/master/LICENSE) before using this software.

data/lib/xignite/array.rb

@@ -0,0 +1,9 @@
+module Xignite
+  class Array < ::Array
+    extend Xignite::Helpers
+
+    def self.build(data, options={})
+      new(data)
+    end
+  end
+end

data/lib/xignite/configuration.rb

@@ -0,0 +1,10 @@
+module Xignite
+  class Configuration
+    attr_accessor :username, :https, :endpoint, :request_method
+
+    def initialize
+      self.endpoint = Xignite::URL
+      self.request_method = :get
+    end
+  end
+end

data/lib/xignite/hash.rb

@@ -0,0 +1,24 @@
+module Xignite
+  class Hash < ::Hash
+    extend Xignite::Helpers
+    
+    def self.build(data, options={})
+      new.tap do |obj|
+        data.each do |k, v|
+          v = self.build(v, options) if v.class.name == 'Hash'
+          obj[underscore(k)] = case v
+            when /^[\d,\.]+$/
+              v.to_f
+            when /^[\d,\/]+$/
+              Date.strptime(v, '%m/%d/%Y')
+            when /^\d+:\d+:\d+ [APM]{2}$/
+              tz = ::TZInfo::Timezone.get(options[:timezone] || 'GMT')
+              tz.local_to_utc(Time.strptime("#{data['Date']} #{v}", "#{DATE_FORMAT} #{TIME_FORMAT}"))
+            else
+              v
+          end
+        end
+      end
+    end
+  end
+end

data/lib/xignite/helpers.rb

@@ -0,0 +1,28 @@
+module Xignite
+  module Helpers
+
+    # active_support/inflector/methods.rb
+    def underscore(camel_cased_word)
+      word = camel_cased_word.to_s.dup
+      word.gsub!(/::/, '/')
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
+    end
+
+    # active_support/inflector/methods.rb
+    def constantize(camel_cased_word)
+      names = camel_cased_word.split('::')
+      names.shift if names.empty? || names.first.empty?
+
+      constant = Object
+      names.each do |name|
+        constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+      end
+      constant
+    end
+
+  end
+end

data/lib/xignite/service.rb

@@ -0,0 +1,82 @@
+module Xignite
+  class Service
+    extend Xignite::Helpers
+    include Xignite::Helpers
+
+    class << self
+      attr_accessor :options
+
+      def post(options={})
+        response = Curl::Easy.http_post(endpoint, *[].tap do |postbody|
+          postbody << Curl::PostField.content('Header_Username', Xignite.configuration.username) if Xignite.configuration.username
+          options.each do |key, value|
+            postbody << Curl::PostField.content(key, value)
+          end
+        end)
+        new(response)
+      end
+
+      def get(options={})
+        options = options.merge('Header_Username' => Xignite.configuration.username) if Xignite.configuration.username
+        querystring = options.map do |key, value|
+          "#{CGI.escape(key.to_s).gsub(/%(5B|5D)/n) { [$1].pack('H*') }}=#{CGI.escape(value)}"
+        end.sort * '&'
+        response = Curl::Easy.http_get([endpoint, querystring].reject{|s| s == '' }.join('?'))
+        new(response)
+      end
+
+      private
+      
+      def endpoint
+        names = name.split('::')
+        "#{protocol}://#{Xignite.configuration.endpoint}/x#{names[1]}.asmx/#{names[2]}"
+      end
+
+      def protocol
+        Xignite.configuration.https ? 'https' : 'http'
+      end
+
+      def operations(ops)
+        ops.each do |operation, options|
+          underscored_name = underscore(operation)
+          const_set(operation, Class.new(self))
+          const_get(operation).options = options
+          class_eval <<-EOF
+            class << self
+              def #{underscored_name}(options={})
+                #{name}::#{operation}.send(Xignite.configuration.request_method, options)
+              end
+              alias :#{operation} :#{underscored_name}
+            end
+          EOF
+        end
+      end
+    end
+
+    def initialize(curl_response=nil)
+      return super if curl_response.nil?
+      Crack::XML.parse(curl_response.body_str).each do |klass, data|
+        data = weed(data)
+        Xignite.const_set(klass, Class.new(Xignite.const_get(data.class.to_s))) unless Xignite.const_defined?(klass)
+        instance_variable_set("@#{underscore(klass)}", Xignite.const_get(klass).build(data, self.class.options))
+        instance_eval "def #{underscore(klass)} ; @#{underscore(klass)} ; end"
+      end
+    end
+
+    private
+
+    def weed(data)
+      data.reject! { |key| key =~ /\Axmlns/ }
+      key = data.keys.first
+      array = data[key]
+      if data.keys.size == 1 && array.class == ::Array
+        Xignite.const_set(key, Class.new(Xignite::Hash)) unless Xignite.const_defined?(key)
+        array.map do |hash|
+          Xignite.const_get(key).build(hash, self.class.options)
+        end
+      else
+        data
+      end
+    end
+  end
+end

data/lib/xignite/services/currencies.rb

@@ -0,0 +1,44 @@
+module Xignite
+  class Currencies < Service
+
+    operations [
+      ['ListCurrencies',                      {}],
+      ['GetRealTimeCrossRate',                { :timezone => 'Europe/London' }],
+      ['GetRealTimeCrossRateGMT',             {}],
+      ['GetRealTimeCrossRateAsString',        { :timezone => 'Europe/London' }],
+      ['GetLatestCrossRate',                  { :timezone => 'Europe/London' }],
+      ['GetLatestCrossRates',                 { :timezone => 'Europe/London' }],
+      ['GetRealTimeCrossRateTable',           { :timezone => 'Europe/London' }],
+      ['GetRealTimeCrossRateTableAsHTML',     {}],
+      ['GetRealTimeCrossRateTableWithBidAsk', { :timezone => 'Europe/London' }],
+      ['GetHistoricalCrossRate',              { :timezone => 'Europe/London' }],
+      ['GetHistoricalCrossRates',             { :timezone => 'Europe/London' }],
+      ['GetHistoricalCrossRatesAsOf',         { :timezone => 'Europe/London' }],
+      ['GetHistoricalCrossRatesRange',        { :timezone => 'Europe/London' }],
+      ['GetHistoricalCrossRateBidAsk',        { :timezone => 'Europe/London' }],
+      ['GetHistoricalCrossRatesBidAsk',       { :timezone => 'Europe/London' }],
+      ['GetHistoricalCrossRatesBidAskAsOf',   { :timezone => 'Europe/London' }],
+      ['GetHistoricalCrossRatesBidAskRange',  { :timezone => 'Europe/London' }],
+      ['GetHistoricalMonthlyCrossRatesRange', { :timezone => 'Europe/London' }],
+      ['GetHistoricalCrossRateTable',         { :timezone => 'Europe/London' }],
+      ['GetHistoricalCrossRateTables',        { :timezone => 'Europe/London' }],
+      ['GetOfficialCrossRate',                { :timezone => 'Europe/London' }],
+      ['GetOfficialCrossRates',               { :timezone => 'Europe/London' }],
+      ['GetAllCrossRatesForACurrency',        { :timezone => 'Europe/London' }],
+      ['GetCurrencyReport',                   { :timezone => 'Europe/London' }],
+      ['GetAverageHistoricalCrossRate',       { :timezone => 'Europe/London' }],
+      ['GetAverageHistoricalCrossRates',      { :timezone => 'Europe/London' }],
+      ['GetRealTimeForwardRate',              { :timezone => 'Europe/London' }],
+      ['ConvertRealTimeValue',                { :timezone => 'Europe/London' }],
+      ['ConvertHistoricalValue',              { :timezone => 'Europe/London' }],
+      ['GetCurrencyChart',                    {}],
+      ['GetCurrencyChartCustom',              {}],
+      ['GetChartDesign',                      {}],
+      ['GetTicks',                            {}],
+      ['GetTick',                             {}],
+      ['GetHistoricalHighLow',                {}],
+      ['GetIntradayHighLow',                  {}],
+      ['GetCrossRateChange',                  {}]
+    ]
+  end
+end

data/lib/xignite/services/metals.rb

@@ -0,0 +1,43 @@
+module Xignite
+  class Metals < Service
+
+    operations [
+      ['GetLastLondonFixing',                 {}],
+      ['GetLastLondonFixings',                {}],
+      ['GetHistoricalLondonFixing',           {}],
+      ['GetHistoricalLondonFixingRange',      {}],
+      ['GetLastRealTimeMetalQuote',           { :timezone => 'Europe/London' }],
+      ['GetLastRealTimeExtendedMetalQuote',   { :timezone => 'Europe/London' }],
+      ['GetLastRealTimeMetalQuotes',          { :timezone => 'Europe/London' }],
+      ['GetLastRealTimeMetalQuoteGMT',        {}],
+      ['GetLastRealTimeMetalQuotesGMT',       {}],
+      ['GetRealTimeMetalQuote',               { :timezone => 'Europe/London' }],
+      ['GetRealTimeMetalQuotes',              { :timezone => 'Europe/London' }],
+      ['GetHistoricalSpotPrice',              {}],
+      ['GetHistoricalSpotPrices',             {}],
+      ['GetHistoricalSpotPriceRange',         {}],
+      ['GetDelayedMetalFuture',               {}],
+      ['GetAllDelayedMetalFutures',           {}],
+      ['GetHistoricalMetalFuture',            {}],
+      ['GetHistoricalMetalFutureRange',       {}],
+      ['GetMetalSpotChart',                   {}],
+      ['GetMetalSpotChartCustom',             {}],
+      ['GetMetalSpotChartDesign',             {}],
+      ['GetLondonFixingChart',                {}],
+      ['GetLondonFixingChartPreset',          {}],
+      ['GetLondonFixingChartCustom',          {}],
+      ['GetIntradayMetalFutureChart',         {}],
+      ['GetIntradayMetalFutureChartCustom',   {}],
+      ['GetIntradayMetalFutureChartDesign',   {}],
+      ['GetHistoricalMetalFutureChart',       {}],
+      ['GetHistoricalFutureMetalChartCustom', {}],
+      ['GetHistoricalMetalFutureChartDesign', {}],
+      ['GetLastBasePrice',                    {}],
+      ['GetSpotMarketSummary',                {}],
+      ['GetTicks',                            {}],
+      ['GetTick',                             {}],
+      ['GetTopIndustryHeadlines',             {}]
+    ]
+
+  end
+end

data/lib/xignite/version.rb

@@ -0,0 +1,3 @@
+module Xignite
+  VERSION = '0.1.1'
+end

data/lib/xignite.rb

@@ -0,0 +1,28 @@
+require 'cgi'
+require 'crack'
+require 'curl'
+require 'tzinfo'
+require 'xignite/configuration'
+
+module Xignite
+  URL = 'www.xignite.com'
+  DATE_FORMAT = '%m/%d/%Y'
+  TIME_FORMAT = '%I:%M:%S %p'
+
+  class << self
+    def configuration
+      @configuration ||= Xignite::Configuration.new
+    end
+
+    def configure
+      yield configuration if block_given?
+    end
+  end
+end
+
+require 'xignite/helpers'
+require 'xignite/hash'
+require 'xignite/array'
+require 'xignite/service'
+require 'xignite/services/currencies'
+require 'xignite/services/metals'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: xignite
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Nate Clark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70117322796120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70117322796120
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70117322795640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70117322795640
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: &70117322789280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70117322789280
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: &70117322788860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70117322788860
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: &70117322788400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70117322788400
+description: Access the Xignite financial data web services with a simple and intuitive
+  Ruby library
+email:
+- nate@nateclark.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/xignite/array.rb
+- lib/xignite/configuration.rb
+- lib/xignite/hash.rb
+- lib/xignite/helpers.rb
+- lib/xignite/service.rb
+- lib/xignite/services/currencies.rb
+- lib/xignite/services/metals.rb
+- lib/xignite/version.rb
+- lib/xignite.rb
+- LICENSE
+- README.md
+- CHANGELOG.md
+homepage: http://github.com/heythisisnate/xignite
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A Ruby client library for the (Xignite)[http://xignite.com/] web services
+test_files: []