netki 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83d574cc62d629d5731a490958428d5e8324b1b4
+  data.tar.gz: 0f640e9c4f7d8ddc7faa31861c4cc3f34053f067
+SHA512:
+  metadata.gz: 198e72c718bf8f3be1d029e384cb656980fd339ce6e193daa5f5153729a083763f141e952b981b009c66735ed6df563e8d39d915e73f29944102522929bf1f44
+  data.tar.gz: b05e88a104f06aa1f173567fc2546439956f6a3be42782921d1dad2fab2f7a8381883a513f07c10122dabe21b8a921a0837ac5ebc58568e9df66e5d6d172a024

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.3

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in netki.gemspec
+gem 'rake'
+gem 'debugger' unless ENV["RM_INFO"]
+gem 'test-unit'
+gem 'test-unit-mock'
+gem 'httpclient'
+gem 'mocha'
+gem 'webmock'

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2015, Netki, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted
+provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions
+and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
+and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse
+or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,34 @@
+# Ruby Netki Partner API Client
+
+This Ruby gem provides a client for [Netki's](https://netki.com) Partner API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'netki'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install netki
+
+## Usage
+
+See rdoc-generated documentation for this Gem in doc/
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/netkicorp/ruby-partner-client.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require_relative "../lib/netki"
+
+# 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

data/bin/setup

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

data/lib/netki/netki.rb

@@ -0,0 +1,326 @@
+require "rubygems"
+require "bundler/setup"
+require "httpclient"
+require "json"
+
+module Netki
+
+  # Request Utility Functionality
+  def self.process_request(api_key, partner_id, uri, method, bodyData=nil)
+
+    raise "Invalid HTTP Method" unless ['GET','POST','PUT','DELETE'].include? method
+
+    # Setup Headers
+    headers = {}
+    headers["Content-Type"] = "application/json"
+    headers["Authorization"] = api_key
+    headers["X-Partner-ID"] = partner_id
+
+    # Setup Request Options
+    opts = {}
+    opts[:header] = headers
+    opts[:body] = bodyData if bodyData
+
+    client = HTTPClient.new
+    _uri = URI.parse(uri)
+    response = client.request(method, _uri, opts)
+
+    # Short Circuit Return if 204 Response on DELETE
+    return {} if response.code == 204 && method == "DELETE"
+
+    # We should have response content at this point
+    raise "Empty Response Received" if response.content.nil? || response.content.empty?
+
+    # Verify we have the correct content type
+    raise "Non-JSON Content Type" if response.headers['Content-Type'] != 'application/json'
+
+    # Make Sure We Can Decode JSON Response
+    begin
+      ret_data = JSON.parse(response.content)
+    rescue JSON::ParserError => e
+      raise "Invalid JSON Response Received"
+    end
+
+    # Process Error
+    if response.code >= 300 || !ret_data['success']
+      err = ret_data['message']
+      if ret_data.has_key? 'failures'
+        fails = []
+        ret_data['failures'].each do |f|
+          fails.push(f['message'])
+        end
+        err = err + "[FAILURES: " + fails.join(", ") + "]"
+      end
+      raise err
+    end
+
+    return ret_data
+  end
+
+##
+# The WalletName object represents a Netki Wallet Name object.
+#
+  class WalletName
+
+    ##
+    # :args: domain_name, name, wallets, external_id, id
+    def initialize(domain_name, name, wallets={}, external_id=nil, id=nil) #:nodoc:
+      @id = id
+      @domain_name = domain_name
+      @name = name
+      @wallets = wallets
+      @external_id = external_id
+    end
+
+    attr_reader :id
+    attr_reader :domain_name
+    attr_reader :name
+    attr_reader :external_id
+
+    attr_writer :id
+    attr_writer :domain_name
+    attr_writer :name
+    attr_writer :external_id
+
+    # :section: Getters
+
+    # Get Address for Existing Currency
+    def get_address(currency)
+      @wallets[currency]
+    end
+
+    # Get Wallet Name Array of Used Currencies
+    def used_currencies
+      @wallets.keys
+    end
+
+    # :section: Currency Address Operations
+
+    # Set the address or URI for the given currency for this wallet name
+    def set_currency_address(currency, address)
+      @wallets[currency] = address
+    end
+
+    # Remove a used currency from this wallet name
+    def remove_currency(currency)
+      @wallets.delete(currency) if @wallets.has_key? currency
+    end
+
+    # :section: Setters
+
+    def set_api_opts(api_url, partner_id, api_key) # :nodoc:
+      @api_url = api_url
+      @partner_id = partner_id
+      @api_key = api_key
+    end
+
+    # :section: Actions
+
+    # Save the currency WalletName object to the remote service
+    def save
+      wallet_data = []
+      @wallets.each do |currency, wallet_address|
+        wallet_data.push({
+                             currency: currency,
+                             wallet_address: wallet_address
+                         })
+      end
+
+      wn_data = {
+          domain_name: @domain_name,
+          name: @name,
+          wallets: wallet_data,
+          external_id: @external_id
+      }
+
+      wn_api_data = {}
+      wn_api_data['wallet_names'] = [wn_data,]
+
+      if @id
+        wn_data['id'] = @id
+        response = Netki.process_request(@api_key, @partner_id, "#{@api_url}/v1/partner/walletname", 'PUT', JSON.dump(wn_api_data))
+      else
+        response = Netki.process_request(@api_key, @partner_id, "#{@api_url}/v1/partner/walletname", 'POST', JSON.dump(wn_api_data))
+      end
+
+      unless @id
+        response['wallet_names'].each do |wn|
+          if response['success'] && wn['domain_name'] == @domain_name && wn['name'] == @name
+            @id = wn['id']
+          else
+            raise 'Success, but invalid response received!'
+          end
+        end
+      end
+
+    end
+
+    # Delete this WalletName object from the remote service
+    def delete
+      raise 'Unable to Delete Object that Does Not Exist Remotely' unless @id
+
+      wn_api_data = {
+          wallet_names: [{domain_name: @domain_name, id: @id}]
+      }
+
+      Netki.process_request(@api_key, @partner_id, "#{@api_url}/v1/partner/walletname", 'DELETE', JSON.dump(wn_api_data))
+    end
+  end
+
+  class NetkiPartner
+
+    ##
+    # The Netki object must be initialized with the Partner ID and API Key to be useful
+    #
+    # * Partner ID -> Netki Partner ID is available on your partner API Key Page
+    # * API Key -> Netki API Key is available only upon API Key creation. Be sure to store it somewhere safe!
+    #
+
+    attr_reader :partner_id
+    attr_reader :api_key
+    attr_reader :api_url
+
+    attr_writer :partner_id
+    attr_writer :api_key
+    attr_writer :api_url
+
+    def initialize(partner_id=nil, api_key=nil, api_url='https://api.netki.com')
+      @partner_id = partner_id
+      @api_key = api_key
+      @api_url = api_url
+    end
+
+    ##
+    # Create a new Partner
+    # * partner_name -> Name of new sub-partner to create
+    #
+    def create_new_partner(partner_name)
+      encoded_partner_name = URI.encode(partner_name)
+      response = Netki.process_request(@api_key, @partner_id, "#{@api_url}/v1/admin/partner/#{encoded_partner_name}", method='POST')
+      response['partner']['id']
+    end
+
+    ##
+    # List current and sub partners
+    # Returns a list of partner Hashes, each containing an id and name key
+    #
+    def get_partners()
+      response = Netki.process_request(@api_key, @partner_id, "#{@api_url}/v1/admin/partner", method='GET')
+      response['partners']
+    end
+
+    ##
+    # Delete a Partner
+    # * partner_name -> Name of sub-partner to delete
+    # NOTE: You cannot delete your own partner resource
+    #
+    def delete_partner(partner_name)
+      encoded_partner_name = URI.encode(partner_name)
+      Netki.process_request(@api_key, @partner_id, "#{@api_url}/v1/admin/partner/#{encoded_partner_name}", method='DELETE')
+      true
+    end
+
+    ##
+    # Create a new domain
+    # * domain_name -> Name of new domain to create
+    # * partner_id -> (optional) Partner that should own the new domain
+    #
+    def create_new_domain(domain_name, partner_id=nil)
+      api_data = {}
+      api_data['partner_id'] = partner_id unless partner_id.nil?
+      Netki.process_request(@api_key, @partner_id, "#{@api_url}/v1/partner/domain/#{domain_name}", method='POST', JSON.dump(api_data))
+      true
+    end
+
+    ##
+    # List available domain resources
+    # Returns a list of domain Hashes, each containing a domain_name and tld_type key
+    #
+    def get_domains()
+      response = Netki.process_request(@api_key, @partner_id, "#{@api_url}/api/domain", method='GET')
+      response['domains']
+    end
+
+    ##
+    # List status of domain resources
+    # * domain_name -> (Optional) Name of domain to return status for
+    #
+    # If domain_name is omitted status is returned for all available domain resources.
+    #
+    # Returns a list of Hashes, each containing current status for each domain
+    #
+    def get_domain_status(domain_name=nil)
+
+      uri="#{@api_url}/v1/partner/domain"
+      uri << "/#{domain_name}" unless domain_name.nil?
+
+      response = Netki.process_request(@api_key, @partner_id, uri, method='GET')
+      response['domains']
+    end
+
+    ##
+    # Get DNSSEC Status of Domain
+    # * domain_name -> (Required) Name of domain to get DNSSEC status for
+    #
+    # Returns a hash containing the follow DNSSEC-related keys:
+    # - ds_records (list)
+    # - public_key_signing_key
+    # - nextroll_date
+    # - nameservers (list)
+
+    def get_domain_dnssec(domain_name)
+      Netki.process_request(@api_key, @partner_id, "#{@api_url}/v1/partner/domain/dnssec/#{domain_name}", method='GET')
+    end
+
+    ##
+    # Delete a Domain
+    # * domain_name -> Name of delete to delete
+    #
+    def delete_domain(domain_name)
+      Netki.process_request(@api_key, @partner_id, "#{@api_url}/v1/partner/domain/#{domain_name}", method='DELETE')
+      true
+    end
+
+
+    ##
+    # Create a new Wallet Name object using this factory method.
+    # * domain_name -> The pre-configured domain name you would like to add this new wallet name to
+    # * name -> The DNS name that you would like this new wallet name to have (ie.. name.domain_name)
+    # * wallets -> This is a hash where the key is the currency (ie.. btc, ltc, dgc, tusd) and the value is the wallet address or URL of the BIP32 / BIP70 address server
+    # * external_id -> Any unique external ID that you may want to use to track this specific wallet name
+    #
+    def create_new_walletname(domain_name, name, wallets={}, external_id=nil)
+      new_wn = WalletName.new(domain_name, name, wallets, external_id)
+      new_wn.set_api_opts(@api_url, @partner_id, @api_key)
+      new_wn
+    end
+
+    ##
+    # Returns an array of WalletName objects based on the given search parameters:
+    # * domain_name -> The pre-configured domain that you have already been using for wallet names
+    # * external_id -> The external ID previously given to the single wallet name you want to retrieve
+    def get_wallet_names(domain_name=nil, external_id=nil)
+      args = []
+      args.push("domain_name=#{domain_name}") if domain_name
+      args.push("external_id=#{external_id}") if external_id
+
+      uri = "#{@api_url}/v1/partner/walletname"
+      uri = (uri + "?" + args.join("&")) unless args.empty?
+      response = Netki.process_request(@api_key, @partner_id, uri, method='GET')
+
+      return [] if !response.has_key? 'wallet_name_count' || response['wallet_name_count'] == 0
+
+      wn_list = []
+      response['wallet_names'].each do |wn|
+        wallets = {}
+        wn['wallets'].each do |wallet|
+          wallets[wallet['currency']] = wallet['wallet_address']
+        end
+        wn_obj = WalletName.new(wn['domain_name'], wn['name'], wallets, wn['external_id'], wn['id'])
+        wn_obj.set_api_opts(@api_url, @partner_id, @api_key)
+        wn_list.push(wn_obj)
+      end
+      wn_list
+    end
+  end
+end

data/lib/netki/version.rb

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

data/lib/netki.rb

@@ -0,0 +1,6 @@
+require_relative 'netki/version'
+require_relative 'netki/netki'
+
+module Netki
+
+end

data/netki.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'netki/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "netki"
+  spec.version       = Netki::VERSION
+  spec.licenses      = ['BSD-3-Clause']
+  spec.authors       = ["Matt David"]
+  spec.email         = ["opensource@netki.com"]
+
+  spec.summary       = %q{Netki Partner API}
+  spec.description   = %q{Netki module that provides access to the Netki Wallet Name Partner API}
+  spec.homepage      = "https://github.com/netkicorp/ruby-partner-client"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httpclient", "~> 2.6"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit", "~> 3.1"
+  spec.add_development_dependency "test-unit-mock", "~> 0.3"
+  spec.add_development_dependency "mocha", "~> 1.1"
+  spec.add_development_dependency "webmock", "~> 1.21"
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: netki
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt David
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: test-unit-mock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: Netki module that provides access to the Netki Wallet Name Partner API
+email:
+- opensource@netki.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/netki.rb
+- lib/netki/netki.rb
+- lib/netki/version.rb
+- netki.gemspec
+homepage: https://github.com/netkicorp/ruby-partner-client
+licenses:
+- BSD-3-Clause
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Netki Partner API
+test_files: []