inkling_api 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+lib/inkling_api_test_config.rb

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in inkling_api.gemspec
+gemspec

data/README.md

@@ -0,0 +1,23 @@
+InklingAPI
+----------
+
+To run the tests
+================
+
+create a file in lib/inkling_api_test_config.rb that looks like the following
+
+    module InklingApiTestConfig
+      class << self
+        def url
+          "https://url.inklingmarkets.com"
+        end
+
+        def login
+          "some-login"
+        end
+
+        def password
+          "some-password"
+        end
+      end
+    end

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'autospec')

data/bin/convert_to_should_syntax

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'convert_to_should_syntax' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('shoulda', 'convert_to_should_syntax')

data/bin/edit_json.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'edit_json.rb' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('json', 'edit_json.rb')

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('inkling_api', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('inkling_api', 'ldiff')

data/bin/minitar

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'minitar' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('inkling_api', 'minitar')

data/bin/nokogiri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'nokogiri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('inkling_api', 'nokogiri')

data/bin/prettify_json.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'prettify_json.rb' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('json', 'prettify_json.rb')

data/bin/rackup

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('inkling_api', 'rackup')

data/bin/rdebug

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rdebug' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('ruby-debug19', 'rdebug')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/spec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'spec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('inkling_api', 'spec')

data/inkling_api.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "inkling_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "inkling_api"
+  s.version     = InklingApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["David Chapman"]
+  s.email       = ["david@isotope11.com"]
+  s.homepage    = "http://www.isotope11.com/"
+  s.summary     = %q{Gem to interact with inkling markets API}
+
+  s.rubyforge_project = "inkling_api"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('faraday', '~> 0.7.4')
+  s.add_dependency('faraday-stack', '~> 0.1.3')
+  s.add_dependency('hashie', '~> 1.1.0')
+  s.add_dependency('activesupport', '~> 3.0.9')
+  s.add_dependency('i18n', '~> 0.6.0')
+
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('json_spec', '~> 0.6.0')
+  s.add_development_dependency('shoulda', '~> 2.11.3')
+  s.add_development_dependency('ruby-debug19')
+end

data/lib/inkling_api.rb

@@ -0,0 +1,89 @@
+require 'faraday_stack'
+require 'inkling_api/faraday_middlewares'
+require 'hashie/mash'
+require 'inkling_api/activesupport_yaml_hack'
+
+module InklingApi
+  module Configuration
+    def configure
+      yield self
+    end
+  end
+
+  class Mashify < Faraday::Response::Middleware
+    def on_complete(env)
+      super if Hash === env[:body]
+    end
+
+    def parse(body)
+      Hashie::Mash.new(body)
+    end
+  end
+
+  class PreserveRawBody < Faraday::Response::Middleware
+    def on_complete(env)
+      env[:raw_body] = env[:body]
+    end
+  end
+
+  module Connection
+    def url=(url)
+      @url = url
+    end
+
+    def login=(login)
+      @login = login
+    end
+
+    def password=(password)
+      @password = password
+    end
+
+    def connection
+      raise "set_url first" unless @url
+      @connection ||= begin
+        conn = Faraday.new(@url) do |b|
+          b.use FaradayStack::ResponseJSON, content_type: 'application/json'
+          b.use FaradayMiddlewares::ResponseXMLToHash, content_type: 'application/xml'
+          b.use PreserveRawBody
+          #b.use FaradayStack::Caching, cache, strip_params: %w[access_token client_id] unless cache.nil?
+          b.response :raise_error
+          #b.use Faraday::Response::Logger
+          b.use FaradayStack::Instrumentation
+          b.adapter Faraday.default_adapter
+          b.use Mashify
+        end
+
+        conn.basic_auth(@login, @password)
+
+        conn
+      end
+    end
+
+    def get(path, params = nil)
+      connection.get(path) do |request|
+        request.params = params if params
+      end
+    end
+  end
+
+  module ApiMethods
+    def get(path, params = nil)
+      raw = params && params.delete(:raw)
+      response = super
+      raw ? response.env[:raw_body] : response.body
+    end
+
+    def market(market_id, *args)
+      get("markets/#{market_id}.xml", *args)
+    end
+
+    def markets(*args)
+      get("markets.json", *args)
+    end
+  end
+
+  extend Configuration
+  extend Connection
+  extend ApiMethods
+end

data/lib/inkling_api/activesupport_yaml_hack.rb

@@ -0,0 +1,11 @@
+require 'active_support'
+# Apparently ActiveSupport moved some stuff around and FaradayStack is not wise to it
+unless defined?(ActiveSupport::JSON::Backends::Yaml::DATE_REGEX)
+  module ActiveSupport::JSON
+    module Backends
+      module Yaml
+        DATE_REGEX = ::ActiveSupport::JSON::DATE_REGEX
+      end
+    end
+  end
+end

data/lib/inkling_api/faraday_middlewares.rb

@@ -0,0 +1,4 @@
+module FaradayMiddlewares
+  autoload :ResponseXMLSlop, 'inkling_api/faraday_middlewares/response_xml_slop'
+  autoload :ResponseXMLToHash, 'inkling_api/faraday_middlewares/response_xml_to_hash'
+end

data/lib/inkling_api/faraday_middlewares/response_xml_slop.rb

@@ -0,0 +1,12 @@
+module FaradayMiddlewares
+  class ResponseXMLSlop < ::FaradayStack::ResponseMiddleware
+    dependency do
+      require 'nokogiri'
+      Nokogiri::Slop
+    end
+    
+    define_parser do |body|
+      Nokogiri::Slop body
+    end
+  end
+end

data/lib/inkling_api/faraday_middlewares/response_xml_to_hash.rb

@@ -0,0 +1,12 @@
+module FaradayMiddlewares
+  class ResponseXMLToHash < ::FaradayStack::ResponseMiddleware
+    dependency do
+      require 'active_support/core_ext'
+      Hash
+    end
+
+    define_parser do |body|
+      Hash.from_xml body
+    end
+  end
+end

data/lib/inkling_api/version.rb

@@ -0,0 +1,3 @@
+module InklingApi
+  VERSION = "0.0.1"
+end

data/spec/inkling_api_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'ruby-debug'
+require 'inkling_api_test_config'
+
+describe InklingApi do
+
+  let(:url)      {InklingApiTestConfig.url}
+  let(:login)    {InklingApiTestConfig.login}
+  let(:password) {InklingApiTestConfig.password}
+  let(:inkling_api) do
+    InklingApi.url = url
+    InklingApi.login = login
+    InklingApi.password = password
+    InklingApi
+  end
+
+  %w( configure connection get markets market ).each do |meth|
+    it "should respond to #{meth}" do
+      inkling_api.should respond_to(meth.to_sym)
+    end
+  end
+
+  it "should not raise error on getting a connection" do
+    lambda{ inkling_api.connection }.should_not raise_error
+  end
+
+  it "should get a list of markets" do
+    inkling_api.markets.should be_an(Array)
+  end
+
+  # NOTE: This will only work if the markets aren't empty
+  it "should get a market" do
+    markets = inkling_api.markets
+    inkling_api.market(markets.first["id"]).should be_a(Hash)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'inkling_api'
+require 'json_spec'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: inkling_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Chapman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-09 00:00:00.000000000 +00:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &25789460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *25789460
+- !ruby/object:Gem::Dependency
+  name: faraday-stack
+  requirement: &25782880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *25782880
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &25782420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *25782420
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &25781820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: *25781820
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &25781200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *25781200
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &25780700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *25780700
+- !ruby/object:Gem::Dependency
+  name: json_spec
+  requirement: &25780040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *25780040
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &25779520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+  type: :development
+  prerelease: false
+  version_requirements: *25779520
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &25779080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *25779080
+description: 
+email:
+- david@isotope11.com
+executables:
+- autospec
+- convert_to_should_syntax
+- edit_json.rb
+- htmldiff
+- ldiff
+- minitar
+- nokogiri
+- prettify_json.rb
+- rackup
+- rdebug
+- rspec
+- spec
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- bin/autospec
+- bin/convert_to_should_syntax
+- bin/edit_json.rb
+- bin/htmldiff
+- bin/ldiff
+- bin/minitar
+- bin/nokogiri
+- bin/prettify_json.rb
+- bin/rackup
+- bin/rdebug
+- bin/rspec
+- bin/spec
+- inkling_api.gemspec
+- lib/inkling_api.rb
+- lib/inkling_api/activesupport_yaml_hack.rb
+- lib/inkling_api/faraday_middlewares.rb
+- lib/inkling_api/faraday_middlewares/response_xml_slop.rb
+- lib/inkling_api/faraday_middlewares/response_xml_to_hash.rb
+- lib/inkling_api/version.rb
+- spec/inkling_api_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://www.isotope11.com/
+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: '0'
+requirements: []
+rubyforge_project: inkling_api
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Gem to interact with inkling markets API
+test_files: []