ndb-ruby 0.2.0

data/spec/ndb/food_report_spec.rb

@@ -0,0 +1,19 @@
+require "./spec/spec_helper.rb"
+
+describe NDB::FoodReport do
+  describe ".retrieve" do
+    it "returns a report by ndbno" do
+      VCR.use_cassette("food_report_ndbno") do
+        result = NDB::FoodReport.retrieve(ndbno: "01009")
+        expect(result["report"]["food"]["ndbno"]).to eq("01009")
+      end
+    end
+
+    it "returns a report of a specific type" do
+      VCR.use_cassette("food_report_type") do
+        result = NDB::FoodReport.retrieve(ndbno: "01009", type: "s")
+        expect(result["report"]["type"]).to eq("Statistics")
+      end
+    end
+  end
+end

data/spec/ndb/list_spec.rb

@@ -0,0 +1,33 @@
+require "./spec/spec_helper"
+
+describe NDB::List do
+  describe ".retrieve" do
+    it "retrieves a list by type" do
+      VCR.use_cassette("list_type") do
+        result = NDB::List.retrieve(lt: "n")
+        expect(result["list"]["lt"]).to eq("n")
+      end
+    end
+
+    it "retrieves a list with a max set" do
+      VCR.use_cassette("list_max") do
+        result = NDB::List.retrieve(max: 100)
+        expect(result["list"]["item"].count).to eq(100)
+      end
+    end
+
+    it "retrieves a list with an offset" do
+      VCR.use_cassette("list_offset") do
+        result = NDB::List.retrieve(offset: 1)
+        expect(result["list"]["start"]).to eq(1)
+      end
+    end
+
+    it "retrieves a list with a sort order" do
+      VCR.use_cassette("list_sort") do
+        result = NDB::List.retrieve(sort: "id")
+        expect(result["list"]["sort"]).to eq("id")
+      end
+    end
+  end
+end

data/spec/ndb/nutrient_report_spec.rb

@@ -0,0 +1,49 @@
+require "./spec/spec_helper"
+
+describe NDB::NutrientReport do
+  describe ".retrieve" do
+    it "returns a report based on a food group" do
+      VCR.use_cassette("nutrient_report_food_group") do
+        result = NDB::NutrientReport.retrieve(nutrients: 205, fg: "0100")
+        group = result["report"]["groups"].first
+        expect(group["id"]).to eq("0100")
+      end
+    end
+
+    it "returns a report with a max set" do
+      VCR.use_cassette("nutrient_report_max") do
+        result = NDB::NutrientReport.retrieve(nutrients: 205, max: 100)
+        expect(result["report"]["foods"].count).to eq(100)
+      end
+    end
+
+    it "returns a report with an offset" do
+      VCR.use_cassette("nutrient_report_offset") do
+        result = NDB::NutrientReport.retrieve(nutrients: 205, offset: 1)
+        expect(result["report"]["start"]).to eq(1)
+      end
+    end
+
+    it "returns a report for a single ndbno" do
+      VCR.use_cassette("nutrient_report_ndbno") do
+        result = NDB::NutrientReport.retrieve(nutrients: 205, ndbno: "01009")
+        expect(result["report"]["foods"].count).to eq(1)
+      end
+    end
+
+    it "returns a report based on an array of nutrients" do
+      VCR.use_cassette("nutrient_report_nutrients") do
+        result = NDB::NutrientReport.retrieve(nutrients: [205, 204])
+        nutrient = result["report"]["foods"].first["nutrients"].first
+        expect(["205", "204"].include?(nutrient["nutrient_id"])).to eq(true)
+      end
+    end
+
+    it "returns a report with an abridged subset" do
+      VCR.use_cassette("nutrient_report_subset") do
+        result = NDB::NutrientReport.retrieve(nutrients: 205, subset: 1)
+        expect(result["report"]["subset"]).to eq("Abridged List")
+      end
+    end
+  end
+end

data/spec/ndb/search_spec.rb

@@ -0,0 +1,59 @@
+require "./spec/spec_helper"
+
+describe NDB::Search do
+  describe ".perform" do
+    it "returns a list of items" do
+      VCR.use_cassette("search_all_foods") do
+        result = NDB::Search.perform["list"]["item"]
+        expect(result.count >= 1).to eq(true)
+      end
+    end
+
+    context "with default options" do
+      it "returns a list of 50 foods" do
+        VCR.use_cassette("search_all_foods") do
+          result = NDB::Search.perform["list"]["item"]
+          expect(result.count).to eq(50)
+        end
+      end
+    end
+
+    context "with options" do
+      it "returns results for a query" do
+        VCR.use_cassette("search_query") do
+          result = NDB::Search.perform(q: "butter")["list"]["item"]
+          expect(result.first["name"].include?("butter")).to eq(true)
+        end
+      end
+
+      it "returns results for a food group id" do
+        VCR.use_cassette("search_food_group") do
+          result = NDB::Search.perform(fg: "0500")["list"]["item"]
+          expect(result.first["group"]).to eq("Poultry Products")
+        end
+      end
+
+      it "returns results sorted by n (name)" do
+        VCR.use_cassette("search_sort_name") do
+          result = NDB::Search.
+                   perform(q: "Cheddar Cheese", sort: "n")["list"]["item"]
+          expect(result.first["name"].include?("Cheddar Cheese")).to eq(true)
+        end
+      end
+
+      it "returns results based on max" do
+        VCR.use_cassette("search_max_rows") do
+          result = NDB::Search.perform(max: 100)["list"]["item"]
+          expect(result.count).to eq(100)
+        end
+      end
+
+      it "ignores unpermitted options" do
+        VCR.use_cassette("search_all_foods") do
+          result = NDB::Search.perform(format: "XML")["list"]["item"]
+          expect(result.first.is_a?(Hash)).to eq(true)
+        end
+      end
+    end
+  end
+end

data/spec/ndb_spec.rb

@@ -0,0 +1,13 @@
+require "./spec/spec_helper"
+
+describe NDB do
+  describe ".configuration" do
+    it "allow confugiration of an api_key" do
+      NDB.configure do |config|
+        config.api_key = "abc123"
+      end
+
+      expect(NDB.api_key).to eq("abc123")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+if ENV["CODECLIMATE_REPO_TOKEN"]
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+require "./lib/ndb-ruby"
+require "vcr"
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/fixtures/vcr_cassettes"
+  config.hook_into :webmock
+  config.ignore_hosts "codeclimate.com"
+end
+
+RSpec.configure do |c|
+  c.before(:all) do
+    NDB.configure do |config|
+      config.api_key = "DEMO_KEY"
+    end
+  end
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: ndb-ruby
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Alex Stophel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-27 00:00:00.000000000 Z
+dependencies:
+- !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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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'
+- !ruby/object:Gem::Dependency
+  name: json
+  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: Gem to wrap NDB API
+email:
+- alexstophel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ndb-ruby.rb
+- lib/ndb/food_report.rb
+- lib/ndb/list.rb
+- lib/ndb/nutrient_report.rb
+- lib/ndb/search.rb
+- lib/ndb/version.rb
+- ndb-ruby.gemspec
+- spec/fixtures/vcr_cassettes/food_report_ndbno.yml
+- spec/fixtures/vcr_cassettes/food_report_type.yml
+- spec/fixtures/vcr_cassettes/list_max.yml
+- spec/fixtures/vcr_cassettes/list_offset.yml
+- spec/fixtures/vcr_cassettes/list_sort.yml
+- spec/fixtures/vcr_cassettes/list_type.yml
+- spec/fixtures/vcr_cassettes/nutrient_report_food_group.yml
+- spec/fixtures/vcr_cassettes/nutrient_report_max.yml
+- spec/fixtures/vcr_cassettes/nutrient_report_ndbno.yml
+- spec/fixtures/vcr_cassettes/nutrient_report_nutrients.yml
+- spec/fixtures/vcr_cassettes/nutrient_report_offset.yml
+- spec/fixtures/vcr_cassettes/nutrient_report_subset.yml
+- spec/fixtures/vcr_cassettes/search_all_foods.yml
+- spec/fixtures/vcr_cassettes/search_food_group.yml
+- spec/fixtures/vcr_cassettes/search_max_rows.yml
+- spec/fixtures/vcr_cassettes/search_query.yml
+- spec/fixtures/vcr_cassettes/search_sort_name.yml
+- spec/ndb/food_report_spec.rb
+- spec/ndb/list_spec.rb
+- spec/ndb/nutrient_report_spec.rb
+- spec/ndb/search_spec.rb
+- spec/ndb_spec.rb
+- spec/spec_helper.rb
+homepage: 
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Gem to wrap NDB API
+test_files: []