coin_tracking 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25b3b09209a558aa8bbd12b2d1a8f9693fe90f8039f5c596c6b3f87c8f5b2eac
+  data.tar.gz: 337894dc2a92085ce95259b2f486ea0ac193f1353bf850cf843975bd599d7f4d
+SHA512:
+  metadata.gz: db46156e62b85b04990a078c79a1a5054835c8e97480c4f24cda48bfc6ef1422798d3e4bbe85c86ed8885665a3aefdb735bb9abcd73374b065ebae0fbd9ff885
+  data.tar.gz: 9f8f009b5b77236b8728b61aa315f7abcf3873dbefa63e53105124b691e4691eaf813aca695498a9f6b6b0b9b3e86f35d94084c3d25202804a9c007727b30f0f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in coin_tracking.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    coin_tracking (1.0.0)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    multi_xml (0.6.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  coin_tracking!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Carl Mercier
+
+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,53 @@
+# CoinTracking.rb
+
+A Ruby client for CoinTracking.info
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'coin_tracking'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install coin_tracking
+
+## Usage
+
+```ruby
+require 'coin_tracking'
+api = CoinTracking::Api.new API_KEY, SECRET_KEY
+
+api.trades
+api.balance
+api.historical_summary
+api.historical_currency
+api.grouped_balance
+api.gains
+
+# Optionally, you can pass a Hash with additional parameters, as documented at https://cointracking.info/api/api.php.
+# Note that `start` and `end` are special parameters that accept DateTime, Time or a Unix timestamp. This gem does the conversion for you.
+
+api.trades(limit: 100, order: 'DESC', start: 1.year.ago, end: 1525486520)
+
+# Each call returns a CoinTracking::Response object. Here are some of the methods that are available:
+
+response.success?      # => true/false
+response.data          # => Hash
+response.http_response # => Raw response from HTTParty
+response.foobar        # => Syntactic sugar. Same as `response.data['foobar']`.
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cmer/coin_tracking_rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "coin_tracking"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/coin_tracking.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "coin_tracking/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "coin_tracking"
+  spec.version       = CoinTracking::VERSION
+  spec.authors       = ["Carl Mercier"]
+  spec.email         = ["foss@carlmercier.com"]
+
+  spec.summary       = %q{A Ruby client for CoinTracking.info}
+  spec.description   = %q{A Ruby client for CoinTracking.info}
+  spec.homepage      = "https://github.com/cmer/coin_tracking_rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "httparty"
+end

data/lib/coin_tracking.rb

@@ -0,0 +1,7 @@
+require "coin_tracking/version"
+require "coin_tracking/api"
+require "coin_tracking/response"
+
+module CoinTracking
+
+end

data/lib/coin_tracking/api.rb

@@ -0,0 +1,92 @@
+require 'uri'
+require 'httparty'
+require 'openssl'
+
+module CoinTracking
+  class Api
+    API_URL = 'https://cointracking.info/api/v1/'
+    DEBUG   = false
+
+    def initialize(api_key, secret_key)
+      @api_key, @secret_key = api_key, secret_key
+    end
+
+    def trades(params = {})
+      api_query('getTrades', sanitize_params(params))
+    end
+
+    def balance(params = {})
+      api_query('getBalance', sanitize_params(params))
+    end
+
+    def historical_summary(params = {})
+      api_query('getHistoricalSummary', sanitize_params(params))
+    end
+
+    def historical_currency(params = {})
+      api_query('getHistoricalCurrency', sanitize_params(params))
+    end
+
+    def grouped_balance(params = {})
+      api_query('getGroupedBalance', sanitize_params(params))
+    end
+
+    def gains(params = {})
+      api_query('getGains', sanitize_params(params))
+    end
+
+    private
+
+    def sanitize_params(params = {})
+      %w(start end).each do |key|
+        sym = key.to_sym
+        params[key] = time_to_unix(params[key]) if params.include?(key)
+        params[sym] = time_to_unix(params[sym]) if params.include?(sym)
+      end
+      params
+    end
+
+    def time_to_unix(v)
+      case v
+      when DateTime, Date
+        v.to_time.to_i
+      when Time, String
+        v.to_i
+      when Integer
+        v
+      else
+        raise ArgumentError.new("Invalid timestamp type: #{v.class}.")
+      end
+    end
+
+    def api_query(action, params = {})
+      params   = { method: action, nonce: nonce }.merge(params)
+      response = HTTParty.post API_URL, body: params, headers: http_headers(params), debug_output: DEBUG ? $stdout : nil
+      puts params
+      CoinTracking::Response.new(response)
+    end
+
+    def encoded_params(params)
+      HTTParty::HashConversions.to_params(params)
+    end
+
+    def signed_params(params)
+      OpenSSL::HMAC.hexdigest('sha512', @secret_key, encoded_params(params))
+    end
+
+    def nonce
+      Time.now.to_i
+    end
+
+    def http_headers(params)
+      { 'Key' => @api_key,
+        'Sign' => signed_params(params),
+        'Connection' => 'close',
+        'User-Agent' => user_agent }
+    end
+
+    def user_agent
+      "CoinTracking.rb/#{CoinTracking::VERSION} (#{CoinTracking::SOURCE_URL})"
+    end
+  end
+end

data/lib/coin_tracking/response.rb

@@ -0,0 +1,43 @@
+require 'json'
+
+module CoinTracking
+  class Response
+    attr_reader :http_response
+
+    def initialize(http_response)
+      @http_response = http_response
+    end
+
+    def to_h
+      if @http_response.parsed_response.is_a?(String)
+        JSON.parse(@http_response.parsed_response)
+      else
+        @http_response.parsed_response
+      end
+    end
+
+    def data
+      to_h
+    end
+
+    def body
+      @http_response.body
+    end
+
+    def success?
+      data['success'].to_i == 1
+    end
+
+    def error?
+      !success?
+    end
+
+    def method_missing(method_sym, *arguments, &block)
+      data.include?(method_sym.to_s) ? data[method_sym.to_s] : super
+    end
+
+    def respond_to?(method_sym, include_private = false)
+      data.include?(method_sym.to_s) ? true : super
+    end
+  end
+end

data/lib/coin_tracking/version.rb

@@ -0,0 +1,4 @@
+module CoinTracking
+  VERSION = "1.0.0"
+  SOURCE_URL = "https://github.com/cmer/coin_tracking_rb"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: coin_tracking
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Carl Mercier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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 client for CoinTracking.info
+email:
+- foss@carlmercier.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- coin_tracking.gemspec
+- lib/coin_tracking.rb
+- lib/coin_tracking/api.rb
+- lib/coin_tracking/response.rb
+- lib/coin_tracking/version.rb
+homepage: https://github.com/cmer/coin_tracking_rb
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A Ruby client for CoinTracking.info
+test_files: []