empireavenue 0.0.1

data/LICENSE.md

@@ -0,0 +1,44 @@
+Copyright (c) 2013 Ralph Janke
+All rights reserved
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to use this software under the AGPL 3.0 licence which can
+be obtained at http://www.gnu.org/licences/agpl-3.0.html
+
+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.
+
+
+Portions of this software have been reused either in unmodified or modified 
+form from the twitter API library (http://github.com/sferik/twitter). The 
+orginal form of those portions are licenced as following: 
+
+Copyright (c) 2006-2012 John Nunemaker, Wynn Netherland, Erik Michaels-Ober, Steve Richert
+
+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,30 @@
+empireavenue
+============
+[![Build Status](https://travis-ci.org/txwikinger/empireavenue.png)](https://travis-ci.org/txwikinger/empireavenue)
+[gem]: https://rubygems.org/gems/empireavenue
+
+
+A Ruby interface to the Empire Avenue API 
+
+## Installation 
+    gem install empireavenue
+
+
+The interface can be used by calling by 
+
+```ruby
+require 'empireavenue'
+
+ea = EmpireAvenue::Client.new({client_id = <client_id of app from EAv>, oauth_token = <oauth_token received from EAv authentication>)
+```
+
+Now this client can perform requests to the Empire Avenue API
+
+Profile Info of accounts
+
+```ruby 
+ea.profile_info(ticker = nil)
+```
+
+receives the profile information of the given ticker. If no argument is given, the associated profile of the authenticated user is provided. Ticker can be a list of up to 100 tickers in an Array.
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/empireavenue.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'empireavenue/version'
+
+Gem::Specification.new do |spec|
+  spec.add_dependency 'faraday', ['~> 0.8', '< 0.10']
+  spec.add_dependency 'multi_json', '~> 1.0'
+  spec.add_dependency 'simple_oauth', '~> 0.2'
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.authors = ["Ralph Janke"]
+  #spec.cert_chain  = ['public_cert.pem']
+  spec.description = %q{A Ruby interface to the Empire Avenue API.}
+  spec.email = ['txwikinger@ubuntu.com']
+  spec.files = %w(LICENSE.md README.md Rakefile empireavenue.gemspec)
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.files += Dir.glob("spec/**/*")
+  spec.homepage = 'http://txwinger.github.com/empireavenue/'
+  spec.licenses = ['AGPL']
+  spec.name = 'empireavenue'
+  spec.require_paths = ['lib']
+  spec.required_rubygems_version = '>= 1.3.6'
+  #spec.signing_key = File.expand_path("~/.gem/private_key.pem") if $0 =~ /gem\z/
+  spec.summary = spec.description
+  spec.test_files = Dir.glob("spec/**/*")
+  spec.version = EmpireAvenue::Version
+end

data/lib/empireavenue/action/buy_group_spec.rb

@@ -0,0 +1,31 @@
+require 'helper'
+
+describe EmpireAvenue::API::Profile do
+  
+  subject do
+    EmpireAvenue::Client.new(:client_id => "CK", :client_secret => "CS", :oauth_token => "OT", :oauth_token_secret => "OS")
+  end
+  
+  before do
+    @ticker_list = ["AVIDBEAVER", "TXWIKINGER"]
+  end
+
+  it "buys all tickers in list with given share number" do
+    
+  end
+  
+
+   it "buys all tickers in list with maximum given amount" do
+    
+  end
+
+     
+  it "buys all tickers in list with closest above given amount" do
+    
+  end
+  
+   it "buys all tickers in list " do
+    
+  end
+
+end

data/lib/empireavenue/api/arguments.rb

@@ -0,0 +1,13 @@
+module EmpireAvenue
+  module API
+    class Arguments < Array
+      attr_reader :options
+
+      def initialize(args)
+        @options = args.last.is_a?(::Hash) ? args.pop : {}
+        super(args)
+      end
+
+    end
+  end
+end

data/lib/empireavenue/api/portfolio_base.rb

@@ -0,0 +1,13 @@
+module EmpireAvenue
+  module API
+    module Portfolio
+      def portfolio_base (ticker = nil, page = nil, maxresults = nil)
+	params = {}
+	params = params.merge({:ticker => ticker}) if ticker
+	params = params.merge({:page => page}) if page
+	params = params.merge({:maxresults => maxresults}) if maxresults
+	get("/portfolio/base", params)
+      end
+    end
+  end
+end

data/lib/empireavenue/api/portfolio_get.rb

@@ -0,0 +1,13 @@
+module EmpireAvenue
+  module API
+    module Portfolio
+      def portfolio_get (ticker = nil, page = nil, maxresults = nil)
+	params = {}
+	params = params.merge({:ticker => ticker}) if ticker
+	params = params.merge({:page => page}) if page
+	params = params.merge({:maxresults => maxresults}) if maxresults
+	get("/portfolio/get", params)
+      end
+    end
+  end
+end

data/lib/empireavenue/api/profile_bank_balance.rb

@@ -0,0 +1,9 @@
+module EmpireAvenue
+  module API
+    module Profile
+      def profile_bank_balance
+	get("/profile/bank/balance")
+      end
+    end
+  end
+end

data/lib/empireavenue/api/profile_info.rb

@@ -0,0 +1,11 @@
+module EmpireAvenue
+  module API
+    module Profile
+      def profile_info (ticker = nil)
+	ticker = ticker.join(",") if ticker.is_a? Array 
+	params = {:ticker => ticker} if ticker
+	get("/profile/info", params)
+      end
+    end
+  end
+end

data/lib/empireavenue/api/profile_shareholders.rb

@@ -0,0 +1,13 @@
+module EmpireAvenue
+  module API
+    module Profile
+      def profile_shareholders (ticker = nil, page = nil, maxresults = nil)
+	params = {}
+	params = params.merge({:ticker => ticker}) if ticker
+	params = params.merge({:page => page}) if page
+	params = params.merge({:maxresults => maxresults}) if maxresults
+	get("/profile/shareholders", params)
+      end
+    end
+  end
+end

data/lib/empireavenue/api/search_recent.rb

@@ -0,0 +1,9 @@
+module EmpireAvenue
+  module API
+    module Search
+      def search_recent
+	get("/search/recent")
+      end
+    end
+  end
+end

data/lib/empireavenue/api/shares_buy.rb

@@ -0,0 +1,11 @@
+module EmpireAvenue
+  module API
+    module Shares
+      def shares_buy (ticker, shares, last_trade = nil)
+	last_trade = profile_info(ticker)[:body][:data][0][:last_trade] unless last_trade
+	params = {:ticker => ticker, :shares => shares, :last_trade => last_trade}
+	post("/shares/buy", params)
+      end
+    end
+  end
+end

data/lib/empireavenue/api/shares_sell.rb

@@ -0,0 +1,11 @@
+module EmpireAvenue
+  module API
+    module Shares
+      def shares_sell (ticker, shares, last_trade = nil)
+	last_trade = profile_info(ticker)[:body][:data][0][:last_trade] unless last_trade
+	params = {:ticker => ticker, :shares => shares, :last_trade => last_trade}
+	post("/shares/sell", params)
+      end
+    end
+  end
+end

data/lib/empireavenue/base.rb

@@ -0,0 +1,126 @@
+require 'empireavenue/identity_map'
+require 'empireavenue/error/identity_map_key_error'
+
+module EmpireAvenue
+  class Base
+    # Define methods that retrieve the value from an initialized instance variable Hash, using the attribute as a key
+    #
+    # @param attrs [Array, Set, Symbol]
+    def self.attr_reader(*attrs)
+      mod = Module.new do
+        attrs.each do |attribute|
+          define_method attribute do
+            @attrs[attribute.to_sym]
+          end
+          define_method "#{attribute}?" do
+            !!@attrs[attribute.to_sym]
+          end
+        end
+      end
+      const_set(:Attributes, mod)
+      include mod
+    end
+
+    # return [EmpireAvenue::IdentityMap]
+    def self.identity_map
+      return unless EmpireAvenue.identity_map
+      @identity_map = EmpireAvenue.identity_map.new unless defined?(@identity_map) && @identity_map.class == EmpireAvenue.identity_map
+      @identity_map
+    end
+
+    # Retrieves an object from the identity map.
+    #
+    # @param attrs [Hash]
+    # @return [EmpireAvenue::Base]
+    def self.fetch(attrs)
+      return unless identity_map
+      if object = identity_map.fetch(Marshal.dump(attrs))
+        return object
+      end
+      return yield if block_given?
+      raise EmpireAvenue::Error::IdentityMapKeyError, "key not found"
+    end
+
+    # Stores an object in the identity map.
+    #
+    # @param object [Object]
+    # @return [EmpireAvenue::Base]
+    def self.store(object)
+      return object unless identity_map
+      identity_map.store(Marshal.dump(object.attrs), object)
+    end
+
+    # Returns a new object based on the response hash
+    #
+    # @param response [Hash]
+    # @return [EmpireAvenue::Base]
+    def self.from_response(response={})
+      fetch_or_new(response[:body])
+    end
+
+    # Retrieves an object from the identity map, or stores it in the
+    # identity map if it doesn't already exist.
+    #
+    # @param attrs [Hash]
+    # @return [EmpireAvenue::Base]
+    def self.fetch_or_new(attrs={})
+      return unless attrs
+      return new(attrs) unless identity_map
+
+      fetch(attrs) do
+        object = new(attrs)
+        store(object)
+      end
+    end
+
+    # Initializes a new object
+    #
+    # @param attrs [Hash]
+    # @return [EmpireAvenue::Base]
+    def initialize(attrs={})
+      @attrs = attrs
+    end
+
+    # Fetches an attribute of an object using hash notation
+    #
+    # @param method [String, Symbol] Message to send to the object
+    def [](method)
+      send(method.to_sym)
+    rescue NoMethodError
+      nil
+    end
+
+    # Retrieve the attributes of an object
+    #
+    # @return [Hash]
+    def attrs
+      @attrs
+    end
+    alias to_hash attrs
+
+    # Update the attributes of an object
+    #
+    # @param attrs [Hash]
+    # @return [EmpireAvenue::Base]
+    def update(attrs)
+      @attrs.update(attrs)
+      self
+    end
+
+  protected
+
+    # @param attr [Symbol]
+    # @param other [EmpireAvenue::Base]
+    # @return [Boolean]
+    def attr_equal(attr, other)
+      self.class == other.class && !other.send(attr).nil? && send(attr) == other.send(attr)
+    end
+
+    # @param other [EmpireAvenue::Base]
+    # @return [Boolean]
+    def attrs_equal(other)
+      self.class == other.class && !other.attrs.empty? && attrs == other.attrs
+    end
+
+  end
+end

data/lib/empireavenue/basic_user.rb

@@ -0,0 +1,10 @@
+require 'empireavenue/identity'
+
+module EmpireAvenue
+  class BasicUser < EmpireAvenue::Identity
+    attr_reader :following, :screen_name
+    alias handle screen_name
+    alias username screen_name
+    alias user_name screen_name
+  end
+end

data/lib/empireavenue/client.rb

@@ -0,0 +1,89 @@
+require 'faraday'
+require 'multi_json'
+#require 'oauth2'
+require 'uri'
+require 'empireavenue/default'
+require 'empireavenue/api/profile_info'
+require 'empireavenue/api/profile_bank_balance'
+require 'empireavenue/api/profile_shareholders'
+require 'empireavenue/api/portfolio_get'
+require 'empireavenue/api/portfolio_base'
+require 'empireavenue/api/search_recent'
+require 'empireavenue/api/shares_buy'
+require 'empireavenue/api/shares_sell'
+require 'empireavenue/error/client_error'
+require 'empireavenue/error/decode_error'
+
+module EmpireAvenue
+  # Wrapper for the Empire Avenue API
+  #
+  class Client
+    include EmpireAvenue::API::Profile
+    include EmpireAvenue::API::Portfolio
+    include EmpireAvenue::API::Shares
+    include EmpireAvenue::API::Search
+    include EmpireAvenue::Configurable
+
+    # Initializes a new Client object
+    #
+    # @param options [Hash]
+    # @return [EmpireAvenue::Client]
+    def initialize(options={})
+      EmpireAvenue::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || EmpireAvenue.instance_variable_get(:"@#{key}"))
+      end
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, params={})
+      request(:delete, path, params)
+    end
+
+    # Perform an HTTP GET request
+    def get(path, params={})
+      request(:get, path, params)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, params={})
+      signature_params = params.values.any?{|value| value.respond_to?(:to_io)} ? {} : params
+      request(:post, path, params, signature_params)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, params={})
+      request(:put, path, params)
+    end
+
+  private
+
+    def request(method, path, params={}, signature_params=params)
+      #params[:client_id] ||= @client_id
+      #params[:access_token] = params[:oauth_token]
+      #params[:access_token] ||= @oauth_token
+      #connection.params = params
+      connection.send(method.to_sym, path, params) do |request|
+	#request.params[:client_id] = params[:client_id]
+	#request.params[:access_token] = params[:access_token]
+        #request.headers[:authorization] = auth_header(method.to_sym, path, signature_params).to_s
+      end.env
+    rescue Faraday::Error::ClientError
+      raise EmpireAvenue::Error::ClientError
+    rescue MultiJson::DecodeError
+      raise EmpireAvenue::Error::DecodeError
+    end
+
+    # Returns a Faraday::Connection object
+    #
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= Faraday.new(@endpoint, @connection_options.merge(:builder => @middleware).merge({:params => {:client_id => @client_id, :access_token => @oauth_token}}))
+    end
+
+    #def auth_header(method, path, params={})
+    #  uri = URI(@endpoint + path)
+    #  #OAuth2::Header.new(method, uri, params, credentials)
+    #end
+
+  end
+end

data/lib/empireavenue/configurable.rb

@@ -0,0 +1,84 @@
+require 'forwardable'
+require 'empireavenue/error/configuration_error'
+
+module EmpireAvenue
+  module Configurable
+    extend Forwardable
+    attr_accessor :client_id, :client_secret, :oauth_token, :oauth_token_secret
+    attr_accessor :endpoint, :connection_options, :identity_map, :middleware
+    def_delegator :options, :hash
+
+    class << self
+
+      def keys
+        @keys ||= [
+          :client_id,
+          :client_secret,
+          :oauth_token,
+          :oauth_token_secret,
+          :endpoint,
+          :connection_options,
+	  :identity_map,
+          :middleware,
+        ]
+      end
+
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    #
+    # @raise [EmpireAvenue::Error::ConfigurationError] Error is raised when supplied
+    #   empire avenue credentials are not a String or Symbol.
+    def configure
+      yield self
+      validate_credential_type!
+      self
+    end
+
+    # @return [Boolean]
+    def credentials?
+      credentials.values.all?
+    end
+
+    def reset!
+      EmpireAvenue::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", EmpireAvenue::Default.options[key])
+      end
+      self
+    end
+    alias setup reset!
+
+  private
+
+    # @return [Hash]
+    def credentials
+      {
+        :client_id => @client_id,
+        :client_secret => @client_secret,
+        :token => @oauth_token,
+        :token_secret => @oauth_token_secret,
+      }
+    end
+
+    # @return [Hash]
+    def options
+      Hash[EmpireAvenue::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+    end
+
+    # Ensures that all credentials set during configuration are of a
+    # valid type. Valid types are String and Symbol.
+    #
+    # @raise [EmpireAvenue::Error::ConfigurationError] Error is raised when
+    #   supplied empire avenue credentials are not a String or Symbol.
+    def validate_credential_type!
+      credentials.each do |credential, value|
+        next if value.nil?
+
+        unless value.is_a?(String) || value.is_a?(Symbol)
+          raise(Error::ConfigurationError, "Invalid #{credential} specified: #{value} must be a string or symbol.")
+        end
+      end
+    end
+
+  end
+end

data/lib/empireavenue/default.rb

@@ -0,0 +1,97 @@
+require 'faraday'
+#require 'faraday/request/multipart'
+require 'empireavenue/configurable'
+require 'empireavenue/error/client_error'
+require 'empireavenue/error/server_error'
+#require 'empireavenue/request/multipart_with_file'
+require 'empireavenue/response/parse_json'
+require 'empireavenue/response/raise_error'
+require 'empireavenue/version'
+
+module EmpireAvenue
+  module Default
+    ENDPOINT = 'https://api.empireavenue.com' unless defined? EmpireAvenue::Default::ENDPOINT
+    CONNECTION_OPTIONS = {
+      :headers => {
+        :accept => 'application/json',
+        :user_agent => "EmpireAvenue Ruby Gem #{EmpireAvenue::Version}",
+      },
+      :request => {
+        :open_timeout => 5,
+        :timeout => 10,
+      },
+      :params => {
+      },
+      :ssl => {
+        :verify => false
+      },
+    } unless defined? EmpireAvenue::Default::CONNECTION_OPTIONS
+    IDENTITY_MAP = false unless defined? EmpireAvenue::Default::IDENTITY_MAP
+    MIDDLEWARE = Faraday::Builder.new do |builder|
+      # Convert file uploads to Faraday::UploadIO objects
+      #builder.use EmpireAvenue::Request::MultipartWithFile
+      # Checks for files in the payload
+      #builder.use Faraday::Request::Multipart
+      # Convert request params to "www-form-urlencoded"
+      builder.use Faraday::Request::UrlEncoded
+      # Handle 4xx server responses
+      builder.use EmpireAvenue::Response::RaiseError, EmpireAvenue::Error::ClientError
+      # Parse JSON response bodies using MultiJson
+      builder.use EmpireAvenue::Response::ParseJson
+      # Handle 5xx server responses
+      builder.use EmpireAvenue::Response::RaiseError, EmpireAvenue::Error::ServerError
+      # Set Faraday's HTTP adapter
+      builder.adapter Faraday.default_adapter
+    end unless defined? EmpireAvenue::Default::MIDDLEWARE
+
+    class << self
+
+      # @return [Hash]
+      def options
+        Hash[EmpireAvenue::Configurable.keys.map{|key| [key, send(key)]}]
+      end
+
+      # @return [String]sferik
+      def client_id
+        ENV['EMPIRE_AVENUE_CLIENT_ID']
+      end
+
+      # @return [String]
+      def client_secret
+        ENV['EMPIRE_AVENUE_CLIENT_SECRET']
+      end
+
+      # @return [String]
+      def oauth_token
+        ENV['EMPIRE_AVENUE_OAUTH_TOKEN']
+      end
+
+      # @return [String]
+      def oauth_token_secret
+        ENV['EMPIRE_AVENUE_OAUTH_TOKEN_SECRET']
+      end
+
+      # @note This is configurable in case you want to use a Empire Avenue-compatible endpoint.
+      # @return [String]
+      def endpoint
+        ENDPOINT
+      end
+
+      def connection_options
+        CONNECTION_OPTIONS
+      end
+      
+      def identity_map
+        IDENTITY_MAP
+      end
+
+      # @note Faraday's middleware stack implementation is comparable to that of Rack middleware.  The order of middleware is important: the first middleware on the list wraps all others, while the last middleware is the innermost one.
+      # @see http://mislav.uniqpath.com/2011/07/faraday-advanced-http/
+      # @return [Faraday::Builder]
+      def middleware
+        MIDDLEWARE
+      end
+
+    end
+  end
+end

data/lib/empireavenue/entity.rb

@@ -0,0 +1,7 @@
+require 'empireavenue/base'
+
+module EmpireAvenue
+  class Entity < EmpireAvenue::Base
+    attr_reader :indices
+  end
+end