bark 0.0.2

data/spec/shared_tests_helper.rb

@@ -0,0 +1,115 @@
+#  This module faciliates the use of shared tests used in R, Python, and herein. 
+#
+#  See https://github.com/OpenTreeOfLife/shared-api-tests  
+#
+module SharedTestsHelper
+
+  # Instances are used to translate string-keyed hashes to symbolized keys.
+  class SymbolizableHash < Hash
+    include Hashie::Extensions::SymbolizeKeys
+  end
+
+  # The location/ of the .json files
+  TEST_SOURCE_BASE = ' https://raw.githubusercontent.com/OpenTreeOfLife/shared-api-tests/master/'
+
+  # Base filenames to test with.
+  TEST_FILES = %w{
+    graph_of_life
+    studies
+    taxonomy
+    tnrs
+    tree_of_life
+  } 
+
+  # Each set of tests is instantiated as an OtTest.  
+  class OtTest
+    # The name of the test, displayed in the specification
+    attr_accessor :name
+
+    # The API wrapper method name to to call. 
+    attr_accessor :method
+
+    # A Hash of input values to be delivered in the JSON payload
+    attr_accessor :input
+
+    # A Hash of specifications, by keyword, i.e. the value of "tests"
+    #
+    #   "tests": {
+    #        "of_type": 
+    #                   ["dict","Response is of wrong type"]
+    #                   ,
+    #        "equals":  [
+    #                   [["nearest_taxon_mrca_rank","'superorder'"],"Fails that nearest_taxon_mrca_rank contains superorder"]
+    #                   ],
+    #        "contains": [
+    #                   ["nearest_taxon_mrca_ott_id","Doesn't contain nearest_taxon_mrca_ott_id"]
+    #                   ]
+    #   }
+    #
+    attr_accessor :tests
+
+    # Translates specified types to Ruby types
+    RESULT_TYPE_CLASSES = {
+      'dict' => Hash
+    }
+
+    # Getter translation of the method attribute.  
+    def method
+      @method.to_sym
+    end
+
+    # Translate the json result type provided in the json specification to a native Ruby value.
+    def result_type
+      if t = @tests['of_type']
+        RESULT_TYPE_CLASSES[t.first]
+      else
+        nil 
+      end
+    end
+  end
+
+  def self.build_test(name, attributes)
+    o = SharedTestsHelper::OtTest.new
+    o.name = name
+    o.method = attributes['test_function']
+ 
+    i = attributes['test_input']
+
+    if i.class == Hash
+      h = SymbolizableHash.new()
+      h.merge!(i)
+      input =  h.symbolize_keys.to_h
+    elsif i == "null" 
+      input = nil
+    else
+      raise "Invalid input type [#{i}]."
+    end
+
+    o.input = input
+    o.tests = attributes['tests']
+
+    o
+  end
+
+  shared_tests = {} 
+
+  begin
+    # TODO: Nicely warn the user when the URL isn't present
+    TEST_FILES.each do |file|
+      shared_tests[file] = [] 
+      uri = URI(TEST_SOURCE_BASE + file + '.json')
+      json = JSON.parse(Net::HTTP.get_response(uri).body)
+
+      json.keys.each do |k|
+        shared_tests[file].push build_test(k, json[k])
+      end
+    end
+
+  rescue JSON::ParserError
+    puts "\n\n!! Warning, unable to build shared tests, some JSON doesn't parse."
+  end
+
+  # The Array of OtTest objects
+  SHARED_TESTS = shared_tests
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# require 'coveralls'
+# Coveralls.wear!
+
+# These are development helpers.
+require 'awesome_print'
+require 'byebug'
+
+# These are required to run tests.
+require 'bark' 
+require 'hashie'
+require 'shared_tests_helper'
+require 'shared_tests'
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: bark
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Matt Yoder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: A wrapper on the Open Tree API, developed during the open tree hackathon
+  in September, 2014.
+email:
+- diapriid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bark.gemspec
+- lib/bark.rb
+- lib/bark/request.rb
+- lib/bark/request/graph_of_life.rb
+- lib/bark/request/studies.rb
+- lib/bark/request/taxonomy.rb
+- lib/bark/request/tnrs.rb
+- lib/bark/request/tree_of_life.rb
+- lib/bark/response.rb
+- lib/bark/version.rb
+- spec/lib/bark_spec.rb
+- spec/lib/request/graph_of_life_spec.rb
+- spec/lib/request/studies_spec.rb
+- spec/lib/request/taxonomy_spec.rb
+- spec/lib/request/tnrs_spec.rb
+- spec/lib/request/tree_of_life_spec.rb
+- spec/lib/request_spec.rb
+- spec/lib/response_spec.rb
+- spec/lib/shared_tests_spec.rb
+- spec/shared_tests.rb
+- spec/shared_tests_helper.rb
+- spec/spec_helper.rb
+homepage: https://github.com/SpeciesFileGroup/bark
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+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: A Ruby wrapper on the Open Tree API.
+test_files:
+- spec/lib/bark_spec.rb
+- spec/lib/request/graph_of_life_spec.rb
+- spec/lib/request/studies_spec.rb
+- spec/lib/request/taxonomy_spec.rb
+- spec/lib/request/tnrs_spec.rb
+- spec/lib/request/tree_of_life_spec.rb
+- spec/lib/request_spec.rb
+- spec/lib/response_spec.rb
+- spec/lib/shared_tests_spec.rb
+- spec/shared_tests.rb
+- spec/shared_tests_helper.rb
+- spec/spec_helper.rb