tankard 0.0.1 → 0.1.0

data/spec/tankard/api/search_spec.rb

@@ -0,0 +1,232 @@
+require 'spec_helper'
+
+describe Tankard::Api::Search do
+
+  let(:search) { Tankard::Api::Search.new(@request) }
+
+  before do
+    @request = mock("request")
+  end
+
+  describe "#query" do
+
+    it "sets options[:q] with the query the user wants to run" do
+      search.query("test")
+      search_options = search.instance_variable_get(:"@options")
+      expect(search_options[:q]).to eql("test")
+    end
+
+    it "returns itself" do
+      expect(search.object_id).to eql(search.query("test").object_id)
+    end
+
+  end
+
+  describe "#params" do
+
+    it "sets parameters" do
+      search.params(withSocialAccounts: "y", withGuilds: "n")
+      search_options = search.instance_variable_get(:"@options")
+      expect(search_options[:withSocialAccounts]).to eql("y")
+      expect(search_options[:withGuilds]).to eql("n")
+    end
+
+    it "merges params when called multiple times" do
+      search.params(test: "n")
+      search.params(test: "y")
+      search_options = search.instance_variable_get(:"@options")
+      expect(search_options[:test]).to eql("y")
+    end
+
+    it "returns itself" do
+      expect(search.object_id).to eql(search.params.object_id)
+    end
+  end
+
+  describe "#type" do
+
+    it "sets options[:type] with the type to search for" do
+      search.type("beer")
+      search_options = search.instance_variable_get(:"@options")
+      expect(search_options[:type]).to eql("beer")
+    end
+
+    it "returns itself" do
+      expect(search.object_id).to eql (search.type("test").object_id)
+    end
+  end
+
+  describe "#page" do
+
+    it "sets options[:p] with the page number to load" do
+      search.page(1)
+      search_options = search.instance_variable_get(:"@options")
+      expect(search_options[:p]).to eql(1)
+    end
+
+    it "returns itself" do
+      expect(search.object_id).to eql(search.page(1).object_id)
+    end
+  end
+
+  describe "#upc" do
+
+    before do
+      search.upc("123")
+      @search_options = search.instance_variable_get(:"@options")
+    end
+
+    it "sets options[:endpoint] with the search endpoint to use" do
+      expect(@search_options[:endpoint]).to eql("upc")
+    end
+
+    it "sets options[:code] with the upc code" do
+      expect(@search_options[:code]).to eql("123")
+    end
+
+    it "returns itself" do
+      expect(search.object_id).to eql(search.upc("123").object_id)
+    end
+  end
+
+  describe "#geo_point" do
+
+    before do
+      search.geo_point(1.23, 4.56)
+      @search_options = search.instance_variable_get(:"@options")
+    end
+
+    it "sets options[:endpoint] with the correct search endpoint to use" do
+      expect(@search_options[:endpoint]).to eql("geo/point")
+    end
+
+    it "sets options[:lat] with the latitude" do
+      expect(@search_options[:lat]).to eql(1.23)
+    end
+
+    it "sets options[:lng] with the longitude" do
+      expect(@search_options[:lng]).to eql(4.56)
+    end
+
+    it "returns itself" do
+      expect(search.object_id).to eql(search.geo_point(1.3, 4.5).object_id)
+    end
+  end
+
+  describe "#each" do
+
+    it "should call raise_if_required_options_not_set" do
+      search.stub(:find_on_single_or_all_pages).and_return(nil)
+      search.should_receive(:raise_if_required_options_not_set)
+      search.each
+    end
+
+    it "calls the super object with the block" do
+      block = -> x { x }
+      search.stub(:raise_if_required_options_not_set).and_return(nil)
+      search.should_receive(:find_on_single_or_all_pages)
+      search.each(&block)
+    end
+  end
+
+  describe "private methods" do
+
+    describe "#raise_if_required_options_not_set" do
+
+      context "the endpoint is not set" do
+
+        it "raises Tankard::Error::NoSearchQuery when the query is not set" do
+          expect { search.send(:raise_if_required_options_not_set) }.to raise_error(Tankard::Error::MissingParameter, "No search query set")
+        end
+
+        it "does not raise Tankard::Error::NoSearchQuery when the query is set" do
+          search.instance_variable_get(:"@options")[:q] = "findme"
+          expect { search.send(:raise_if_required_options_not_set) }.not_to raise_error(Tankard::Error::MissingParameter, "No search query set")
+        end
+      end
+
+      context "the endpoint is set to upc" do
+
+        before do
+          search.instance_variable_get(:"@options")[:endpoint] = "upc"
+        end
+
+        it "raises Tankard::Error::MissingParameter when code is not set" do
+          expect { search.send(:raise_if_required_options_not_set) }.to raise_error(Tankard::Error::MissingParameter, "missing parameter: code")
+        end
+
+        it "does not raise Tankard::Error::MissingParameter when code is set" do
+          search.instance_variable_get(:"@options")[:code] = "1234"
+          expect { search.send(:raise_if_required_options_not_set) }.not_to raise_error(Tankard::Error::MissingParameter)
+        end
+      end
+
+      context "the endpoint is set to geo/point" do
+
+        before do
+          search.instance_variable_get(:"@options")[:endpoint] = "geo/point"
+        end
+
+        it "raises Tankard::Error::MissingParameter when latitude is not set" do
+          search.instance_variable_get(:"@options")[:lng] = 123
+          expect { search.send(:raise_if_required_options_not_set) }.to raise_error(Tankard::Error::MissingParameter, "missing Parameters: lat, lng")
+        end
+
+        it "raises Tankard::Error::MissingParameter when longitude is not set" do
+          search.instance_variable_get(:"@options")[:lat] = 123
+          expect { search.send(:raise_if_required_options_not_set) }.to raise_error(Tankard::Error::MissingParameter, "missing Parameters: lat, lng")
+        end
+
+        it "raises Tankard::Error::MissingParameter when latitude and longitude are not set" do
+          expect { search.send(:raise_if_required_options_not_set) }.to raise_error(Tankard::Error::MissingParameter, "missing Parameters: lat, lng")
+        end
+
+        it "does not raise Tankard::Error::MissingParameter when latitude and longitude are set" do
+          search.instance_variable_get(:"@options")[:lat] = 123
+          search.instance_variable_get(:"@options")[:lng] = 123
+          expect { search.send(:raise_if_required_options_not_set) }.not_to raise_error(Tankard::Error::MissingParameter)
+        end
+      end
+    end
+
+    describe "#http_request_uri" do
+
+      context "no endpoint is set" do
+
+        it "returns search" do
+          expect(search.send(:http_request_uri)).to eql("search")
+        end
+      end
+
+      context "an endpoint is set" do
+
+        before do
+          search.instance_variable_get(:"@options")[:endpoint] = "upc"
+        end
+
+        it "adds the endpoint to the uri" do
+          expect(search.send(:http_request_uri)).to eql("search/upc")
+        end
+
+        it "removes the endpoint from options" do
+          search.send(:http_request_uri)
+          expect(search.instance_variable_get(:"@options")[:endpoint]).to eql(nil)
+        end
+      end
+    end
+
+    describe "#http_client" do
+
+      it "returns the request variable that is passed when the class is created" do
+        expect(search.send(:http_client).object_id).to eql(@request.object_id)
+      end
+    end
+
+    describe "#http_request_parameters" do
+
+      it "returns the options for the request" do
+        expect(search.send(:http_request_parameters).object_id).to eql(search.instance_variable_get(:"@options").object_id)
+      end
+    end
+  end
+end

data/spec/tankard/api/style_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Tankard::Api::Style do
+  let(:style) { Tankard::Api::Style.new(@request) }
+
+  before do
+    @request = mock("request")
+  end
+
+  describe "#find" do
+
+    before do
+      @request.stub(:get).with("style/1", {}).and_return({ "data" => "valid1_found"})
+      @request.stub(:get).with("style/2", {}).and_return({ "data" => "valid2_found"})
+      @request.stub(:get).with("style/3", {}).and_raise(Tankard::Error::HttpError)
+      @request.stub(:get).with("style/4", {}).and_raise(Tankard::Error::HttpError)
+    end
+
+    it_should_behave_like "the find method" do
+      let(:context) { style }
+      let(:valid_items) { [1, 2] }
+      let(:valid_responses) { ["valid1_found", "valid2_found"] }
+      let(:invalid_items) { [3, 4] }
+      let(:valid_invalid_items) { valid_items + invalid_items }
+    end
+  end
+
+  describe "#id" do
+
+    it "sets the options[:id] for the style id passed in" do
+      style.id(1)
+      style_options = style.instance_variable_get(:"@options")
+      expect(style_options[:id]).to eql(1)
+    end
+
+    it "returns itself" do
+      expect(style.object_id).to eql(style.id(1).object_id)
+    end
+  end
+
+  describe "when making a request" do
+
+    context "and the id for a style is not set" do
+
+      it "raises a Tankard::Error::NoStyleId" do
+        expect { style.each { |s| p s } }.to raise_error(Tankard::Error::MissingParameter, "No style id set")
+      end
+    end
+
+    context "and the id for a style is set" do
+
+      before do
+        @request.stub(:get).with("style/1", {}).and_return({ "data" => ["style_valid"] })
+      end
+
+      it "uses the style id in the uri" do
+        expect(style.id(1).collect { |x| x}).to eql(["style_valid"])
+      end
+    end
+  end
+end

data/spec/tankard/api/styles_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Tankard::Api::Styles do
+
+  let(:styles) { Tankard::Api::Styles.new(@request) }
+
+  before do
+    @request = mock("request")
+  end
+
+  describe "when making a request" do
+
+    it "returns the data portion of the request" do
+      @request.stub(:get).with("styles", {}).and_return({"data" => ["test1", "test2"]})
+      expect(styles.collect { |x| x}).to eql(["test1", "test2"])
+    end
+  end
+end

data/spec/tankard/api/utils/find_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Tankard::Api::Utils::Find do
+
+  let(:find) { Class.new { include Tankard::Api::Utils::Find }.new }
+
+  describe "#route" do
+
+    it "raises NoMethodError" do
+      expect { find.send(:route) }.to raise_error(NoMethodError, "Must implement and return the base route")
+    end
+  end
+
+  describe "#http_client" do
+
+    it "raises NoMethodError" do
+      expect { find.send(:http_client) }.to raise_error(NoMethodError, "Must return the http object to make requests with")
+    end
+  end
+
+  describe "#http_request_parameters" do
+
+    it "raises NoMethodError" do
+      expect { find.send(:http_request_parameters) }.to raise_error(NoMethodError, "Must return a hash like structure with request parameters")
+    end
+  end
+end

data/spec/tankard/api/utils/page_finders_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe Tankard::Api::Utils::PageFinders do
+
+  let(:finders) { Class.new { include Tankard::Api::Utils::PageFinders }.new }
+
+  describe "private methods" do
+
+    before do
+      @request = mock("request")
+    end
+
+    describe "#http_request_uri" do
+
+      it "raises NoMethodError" do
+        expect { finders.send(:http_request_uri) }.to raise_error(NoMethodError)
+      end
+    end
+
+    describe "#http_client" do
+
+      it "raises NoMethodError" do
+        expect { finders.send(:http_client) }.to raise_error(NoMethodError)
+      end
+    end
+
+    describe "#http_request_parameters" do
+
+      it "raises NoMethodError" do
+        expect { finders.send(:http_request_parameters) }.to raise_error(NoMethodError)
+      end
+    end
+
+    describe "#call_block_with_data" do
+
+      it "raises Tankard::Error::InvalidResponse when no data" do
+        expect { finders.send(:call_block_with_data, nil, nil) }.to raise_error(Tankard::Error::InvalidResponse)
+      end
+
+      it "accepts a hash of data" do
+        result = []
+        block = -> n { result.push(n) }
+        finders.send(:call_block_with_data, {"test" => "something"}, block)
+        expect(result).to eql([{"test"=> "something"}])
+      end
+
+      it "loops through an array of data" do
+        result = []
+        block = -> n { result.push(n+1) }
+        finders.send(:call_block_with_data, [1,2,3], block)
+        expect(result).to eql([2,3,4])
+      end
+    end
+
+    describe "#find_on_single_page" do
+
+      it "sends response[data] to call_block_with_data" do
+        finders.stub!(:get_request).and_return({"data" => ["test"]})
+        finders.should_receive(:call_block_with_data).with(["test"], nil)
+        finders.send(:find_on_single_page, "test", @request, {}, nil)
+      end
+
+      it "returns 0 when number of pages is not set" do
+        finders.stub!(:get_request).and_return({"data" => ["test"]})
+        finders.stub!(:call_block_with_data).with(["test"], nil)
+        expect(finders.send(:find_on_single_page, "test", @request, {}, nil)).to eql(0)
+      end
+
+      it "returns a value when number of pages is set" do
+        finders.stub!(:get_request).and_return({"data" => ["test"], "numberOfPages" => "3"})
+        finders.stub!(:call_block_with_data).with(["test"], nil)
+        expect(finders.send(:find_on_single_page, "test", @request, {}, nil)).to eql(3)
+      end
+
+    end
+
+    describe "#find_on_all_pages" do
+
+      it "only sets the page when the page is greater than 1" do
+        finders.should_receive(:find_on_single_page).with("test", @request, {}, nil).and_return(2)
+        finders.should_not_receive(:find_on_single_page).with("test", @request, {p:1}, nil)
+        finders.should_receive(:find_on_single_page).with("test", @request, {p:2}, nil).and_return(2)
+
+        finders.send(:find_on_all_pages, "test", @request, {}, nil)
+      end
+    end
+
+    describe "#find_on_single_or_all_pages" do
+
+      it "calls find_with_options when a page is set in options" do
+        finders.should_receive(:find_on_single_page).with("test", nil, {p:2}, nil)
+        finders.send(:find_on_single_or_all_pages, "test", nil, {p:2}, nil)
+      end
+
+      it "calls find_on_all_pages when a page is not set in options" do
+        finders.should_receive(:find_on_all_pages).with("test", nil, {}, nil)
+        finders.send(:find_on_single_or_all_pages, "test", nil, {}, nil)
+      end
+    end
+
+    describe "#each" do
+
+      before do
+        finders.stub!(:http_request_uri).and_return("test")
+        finders.stub!(:http_client).and_return(nil)
+        finders.stub!(:http_request_parameters).and_return({})
+      end
+
+      it "calls find_on_single_or_all_pages" do
+        finders.should_receive(:find_on_single_or_all_pages).with("test", nil, {}, nil)
+        finders.each
+      end
+    end
+  end
+
+end

data/spec/tankard/client_spec.rb

@@ -51,4 +51,63 @@ describe Tankard::Client do
       end
     end
   end
+
+  describe "#search" do
+
+    context "when called" do
+
+      it "does not reuse an existing search object" do
+        search = client.search
+        expect(search.object_id).not_to eql(client.search.object_id)
+      end
+    end
+
+    context "when passed a hash of options" do
+
+      before do
+        @request = mock("request")
+        Tankard::Request.stub!(:new).and_return(@request)
+      end
+
+      it "passes the options to the search object" do
+        Tankard::Api::Search.should_receive(:new).with(@request, { test: 123 })
+        client.search({ test: 123 })
+      end
+    end
+  end
+
+  describe "#styles" do
+
+    context "when called" do
+
+      it "does not reuse an existing styles object" do
+        styles = client.styles
+        expect(styles.object_id != client.styles.object_id).to be_true
+      end
+    end
+  end
+
+  describe "#style" do
+
+    context "when called" do
+
+      it "does not reuse an existing style object" do
+        style = client.style
+        expect(style.object_id).not_to eql(client.style.object_id)
+      end
+    end
+
+    context "when passed a hash of options" do
+
+      before do
+        @request = mock("request")
+        Tankard::Request.stub!(:new).and_return(@request)
+      end
+
+      it "passes the options to the style object" do
+        Tankard::Api::Style.should_receive(:new).with(@request, { test: 123 })
+        client.style({ test: 123 })
+      end
+    end
+  end
 end

data/tankard.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["matthewshafer@mac.com"]
   spec.description   = %q{Connector to the BreweryDB api}
   spec.summary       = %q{Allows easy quering to the breweryDB api}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/matthewshafer/tankard"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tankard
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Matthew Shafer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-03 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -183,19 +183,30 @@ files:
 - lib/tankard/api/beer.rb
 - lib/tankard/api/beers.rb
 - lib/tankard/api/request/get.rb
+- lib/tankard/api/search.rb
+- lib/tankard/api/style.rb
+- lib/tankard/api/styles.rb
+- lib/tankard/api/utils/find.rb
+- lib/tankard/api/utils/page_finders.rb
 - lib/tankard/client.rb
 - lib/tankard/configuration.rb
 - lib/tankard/error.rb
 - lib/tankard/request.rb
 - lib/tankard/version.rb
+- spec/shared_examples_for_find.rb
 - spec/spec_helper.rb
 - spec/tankard/api/beer_spec.rb
 - spec/tankard/api/beers_spec.rb
+- spec/tankard/api/search_spec.rb
+- spec/tankard/api/style_spec.rb
+- spec/tankard/api/styles_spec.rb
+- spec/tankard/api/utils/find_spec.rb
+- spec/tankard/api/utils/page_finders_spec.rb
 - spec/tankard/client_spec.rb
 - spec/tankard/request_spec.rb
 - spec/tankard_spec.rb
 - tankard.gemspec
-homepage: ''
+homepage: https://github.com/matthewshafer/tankard
 licenses:
 - MIT
 metadata: {}
@@ -220,9 +231,15 @@ signing_key:
 specification_version: 4
 summary: Allows easy quering to the breweryDB api
 test_files:
+- spec/shared_examples_for_find.rb
 - spec/spec_helper.rb
 - spec/tankard/api/beer_spec.rb
 - spec/tankard/api/beers_spec.rb
+- spec/tankard/api/search_spec.rb
+- spec/tankard/api/style_spec.rb
+- spec/tankard/api/styles_spec.rb
+- spec/tankard/api/utils/find_spec.rb
+- spec/tankard/api/utils/page_finders_spec.rb
 - spec/tankard/client_spec.rb
 - spec/tankard/request_spec.rb
 - spec/tankard_spec.rb