viagogo-client 0.0.1.pre

data/lib/viagogo/version.rb

@@ -0,0 +1,3 @@
+module Viagogo
+  VERSION = "0.0.1.pre"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require 'viagogo'
+require 'webmock/rspec'
+
+def a_delete(path)
+  a_request(:delete, Viagogo::Client::API_ENDPOINT + path)
+end
+
+def a_get(path)
+  a_request(:get, Viagogo::Client::API_ENDPOINT + path)
+end
+
+def a_head(path)
+  a_request(:head, Viagogo::Client::API_ENDPOINT + path)
+end
+
+def a_post(path)
+  a_request(:post, Viagogo::Client::API_ENDPOINT + path)
+end
+
+def a_put(path)
+  a_request(:put, Viagogo::Client::API_ENDPOINT + path)
+end
+
+def stub_delete(path)
+  stub_request(:delete, Viagogo::Client::API_ENDPOINT + path)
+end
+
+def stub_get(path)
+  stub_request(:get, Viagogo::Client::API_ENDPOINT + path)
+end
+
+def stub_head(path)
+  stub_request(:head, Viagogo::Client::API_ENDPOINT + path)
+end
+
+def stub_post(path)
+  stub_request(:post, Viagogo::Client::API_ENDPOINT + path)
+end
+
+def stub_put(path)
+  stub_request(:put, Viagogo::Client::API_ENDPOINT + path)
+end

data/spec/viagogo/client_spec.rb

@@ -0,0 +1,224 @@
+require 'spec_helper'
+
+shared_examples_for "a Client" do
+  let(:client) { described_class.new(:consumer_key => 'CK',
+                                     :consumer_secret => 'CS',
+                                     :access_token => 'AT',
+                                     :access_token_secret => 'AS') }
+
+  describe "#new" do
+    context "when options are given" do
+      it "sets consumer_key to given value" do
+        expected_consumer_key = "my key"
+        client = described_class.new(:consumer_key => expected_consumer_key)
+        expect(client.consumer_key).to eq(expected_consumer_key)
+      end
+
+      it "sets consumer_secret to given value" do
+        expected_consumer_secret = "my secret"
+        client = described_class.new(:consumer_secret => expected_consumer_secret)
+        expect(client.consumer_secret).to eq(expected_consumer_secret)
+      end
+
+      it "sets access_token to given value" do
+        expected_access_token = "my access token"
+        client = described_class.new(:access_token => expected_access_token)
+        expect(client.access_token).to eq(expected_access_token)
+      end
+
+      it "sets access_token_secret to given value" do
+        expected_access_token_secret = "my access token secret"
+        client = described_class.new(:access_token_secret => expected_access_token_secret)
+        expect(client.access_token_secret).to eq(expected_access_token_secret)
+      end
+
+      it "raises Viagogo::Error::ConfigurationError when :consumer_key is invalid" do
+        expect { described_class.new(:consumer_key => [50, 1]) }.to raise_error Viagogo::ConfigurationError
+      end
+
+      it "raises Viagogo::Error::ConfigurationError when :consumer_secret is invalid" do
+        expect { described_class.new(:consumer_secret => [3, 'A']) }.to raise_error Viagogo::ConfigurationError
+      end
+
+      it "raises Viagogo::Error::ConfigurationError when :access_token is invalid" do
+        expect { described_class.new(:access_token => [3, 'A']) }.to raise_error Viagogo::ConfigurationError
+      end
+
+      it "raises Viagogo::Error::ConfigurationError when :access_token_secret is invalid" do
+        expect { described_class.new(:access_token_secret => [3, 'A']) }.to raise_error Viagogo::ConfigurationError
+      end
+    end
+
+    context "when block is given" do
+      it "passes the current instance to be configured in the block" do
+        actual_client = nil
+        expected_client = described_class.new do |config|
+          config.consumer_key = "CK"
+          config.consumer_secret = "CS"
+          actual_client = config
+        end
+
+        expect(actual_client.object_id).to equal(expected_client.object_id)
+      end
+
+      it "raises Viagogo::Error::ConfigurationError when :consumer_key is invalid" do
+        expect { described_class.new do |config|
+          config.consumer_key = 50
+        end }.to raise_error Viagogo::ConfigurationError
+      end
+
+      it "raises Viagogo::Error::ConfigurationError when :consumer_secret is invalid" do
+        expect { described_class.new do |config|
+          config.consumer_secret = 6
+        end }.to raise_error Viagogo::ConfigurationError
+      end
+
+      it "raises Viagogo::Error::ConfigurationError when :access_token is invalid" do
+        expect { described_class.new do |config|
+          config.access_token = 50
+        end }.to raise_error Viagogo::ConfigurationError
+      end
+
+      it "raises Viagogo::Error::ConfigurationError when :access_token_secret is invalid" do
+        expect { described_class.new do |config|
+          config.access_token_secret = 50
+        end }.to raise_error Viagogo::ConfigurationError
+      end
+    end
+  end
+
+  describe "#user_agent" do
+    it "returns the gem name and version" do
+      version = Viagogo::VERSION
+      expected_user_agent = "viagogo Ruby Gem #{version}"
+      expect(client.user_agent).to eq(expected_user_agent)
+    end
+  end
+
+  describe "#credentials?" do
+    it "returns false if :consumer_key is not supplied" do
+      client = described_class.new(:consumer_secret => "CS",
+                                   :access_token => "AT",
+                                   :access_token_secret => "AS")
+      expect(client.credentials?).to be_false
+    end
+
+    it "returns false if :consumer_secret is not supplied" do
+      client = described_class.new(:consumer_key => "CK",
+                                   :access_token => "AT",
+                                   :access_token_secret => "AS")
+      expect(client.credentials?).to be_false
+    end
+
+    it "returns false if :access_token is not supplied" do
+      client = described_class.new(:consumer_key => "CK",
+                                   :consumer_secret => "CS",
+                                   :access_token_secret => "AS")
+      expect(client.credentials?).to be_false
+    end
+
+    it "returns false if :access_token_secret is not supplied" do
+      client = described_class.new(:consumer_key => "CK",
+                                   :consumer_secret => "CS",
+                                   :access_token => "AT")
+      expect(client.credentials?).to be_false
+    end
+
+    it "returns true if all credentials are supplied" do
+      client = described_class.new(:consumer_key => "CK",
+                                   :consumer_secret => "CS",
+                                   :access_token => "AT",
+                                   :access_token_secret => "AS")
+      expect(client.credentials?).to be_true
+    end
+  end
+
+  describe "#request" do
+    [:get, :post, :head, :put, :delete, :patch].each do |method|
+      context "when HTTP method is #{method}" do
+        it "makes an HTTP request with the parameters given" do
+          expected_path = "/some/path"
+          stub_request(:any, Viagogo::Client::API_ENDPOINT + expected_path)
+          client.send(:request, method, expected_path)
+          expect(a_request(method, Viagogo::Client::API_ENDPOINT + expected_path)).to have_been_made
+        end
+
+        it "makes an HTTP request with JSON Content-Type" do
+          expected_content_type = "application/json"
+          stub_request(:any, /.*/).with(:headers => { "Content-Type" => expected_content_type })
+          client.send(:request, method, "/")
+          expect(a_request(:any, /.*/).with(:headers => { "Content-Type" => expected_content_type })).to have_been_made
+        end
+
+        it "makes an HTTP request with user-agent set to the return value of #user_agent" do
+          expected_user_agent = "some user agent"
+          allow(client).to receive(:user_agent).and_return(expected_user_agent)
+          stub_request(:any, /.*/).with(:headers => { "User-Agent" => expected_user_agent })
+          client.send(:request, method, "/")
+          expect(a_request(:any, /.*/).with(:headers => { "User-Agent" => expected_user_agent })).to have_been_made
+        end
+
+        it "returns the response env Hash" do
+          expected_response_hash = {:body => "abc"}
+          stub_request(:any, Viagogo::Client::API_ENDPOINT + "/foo").to_return(expected_response_hash)
+          actual_response_hash = client.send(:request, method, "/foo", :is_token_request => true)
+          expect(actual_response_hash[:body]).to eq(expected_response_hash[:body])
+        end
+      end
+    end
+  end
+
+  describe "#get" do
+    it "performs an get request" do
+      expected_path = "/custom/path"
+      expected_params = {:foo => "foo", :bar => "bar"}
+      stub_get(expected_path).with(:query => expected_params)
+      client.get(expected_path, expected_params)
+      expect(a_get(expected_path).with(:query => expected_params)).to have_been_made
+    end
+  end
+
+  describe "#head" do
+    it "performs an head request" do
+      expected_path = "/custom/path"
+      expected_params = {:foo => "foo", :bar => "bar"}
+      stub_head(expected_path).with(:query => expected_params)
+      client.head(expected_path, expected_params)
+      expect(a_head(expected_path).with(:query => expected_params)).to have_been_made
+    end
+  end
+
+  describe "#delete" do
+    it "performs an delete request" do
+      expected_path = "/custom/path"
+      expected_params = {:foo => "foo", :bar => "bar"}
+      stub_delete(expected_path).with(:query => expected_params)
+      client.delete(expected_path, expected_params)
+      expect(a_delete(expected_path).with(:query => expected_params)).to have_been_made
+    end
+  end
+
+  describe "#post" do
+    it "performs an post request" do
+      expected_path = "/custom/path"
+      expected_body = {:foo => "foo", :bar => "bar"}
+      stub_post(expected_path).with(:body => expected_body)
+      client.post(expected_path, expected_body)
+      expect(a_post(expected_path).with(:body => expected_body)).to have_been_made
+    end
+  end
+
+  describe "#put" do
+    it "performs an put request" do
+      expected_path = "/custom/path"
+      expected_body = {:foo => "foo", :bar => "bar"}
+      stub_put(expected_path).with(:body => expected_body)
+      client.put(expected_path, expected_body)
+      expect(a_put(expected_path).with(:body => expected_body)).to have_been_made
+    end
+  end
+end
+
+describe Viagogo::Client do
+  it_behaves_like "a Client"
+end

data/spec/viagogo/public/api/categories_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe Viagogo::Public::API::Categories do
+  before do
+    @client = Viagogo::Public::Client.new(:consumer_key => 'CK',
+                                          :consumer_secret => 'CS',
+                                          :access_token => 'AT',
+                                          :access_token_secret => 'AS')
+  end
+
+  describe "#category" do
+    it "makes HTTP get request" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      @client.category 1
+      expect(a_request(:get, /.*/)).to have_been_made
+    end
+
+    it "makes request for the correct resource" do
+      expected_resource = 50
+      expected_params = {:foo => "foo", :bar => "bar"}
+      stub_get("/Public/Category/#{expected_resource}").
+          with(:query => expected_params).
+          to_return(:body => "{}")
+      @client.category expected_resource, expected_params
+      expect(a_get("/Public/Category/#{expected_resource}").with(:query => expected_params)).to have_been_made
+    end
+
+    it "returns Viagogo::Category created from the response" do
+      stub_get("/Public/Category/1").to_return({:body => "{\"Id\": 5, \"Parents\": []}"})
+      expect(@client.category 1).to be_an_instance_of(Viagogo::Category)
+    end
+  end
+
+  describe "#categories_top" do
+    it "makes HTTP get request" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      @client.categories_top "US"
+      expect(a_request(:get, /.*/)).to have_been_made
+    end
+
+    it "makes request for the correct resource" do
+      expected_resource = "/Public/Category/AD/Top"
+      expected_params = {:foo => "foo", :bar => "bar"}
+      stub_get(expected_resource).with(:query => expected_params).to_return(:body => "{}")
+      @client.categories_top "AD", expected_params
+      expect(a_get(expected_resource).with(:query => expected_params)).to have_been_made
+    end
+
+    it "returns Viagogo::Page created from the response" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      expect(@client.categories_top "GB").to be_an_instance_of(Viagogo::Page)
+    end
+  end
+
+  describe "#categories_parents" do
+    it "makes HTTP get request" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      @client.categories_parents "US", 501
+      expect(a_request(:get, /.*/)).to have_been_made
+    end
+
+    it "makes request for the correct resource" do
+      expected_resource = "/Public/Category/GB/Parents/21"
+      expected_params = {:foo => "foo", :bar => "bar"}
+      stub_get(expected_resource).with(:query => expected_params).to_return(:body => "{}")
+      @client.categories_parents "GB", 21, expected_params
+      expect(a_get(expected_resource).with(:query => expected_params)).to have_been_made
+    end
+
+    it "returns Viagogo::Page created from the response" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      expect(@client.categories_parents "GB", 0).to be_an_instance_of(Viagogo::Page)
+    end
+  end
+
+  describe "#categories_children" do
+    it "makes HTTP get request" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      @client.categories_children "US", 501
+      expect(a_request(:get, /.*/)).to have_been_made
+    end
+
+    it "makes request for the correct resource" do
+      expected_resource = "/Public/Category/GB/Children/21"
+      expected_params = {:foo => "foo", :bar => "bar"}
+      stub_get(expected_resource).with(:query => expected_params).to_return(:body => "{}")
+      @client.categories_children "GB", 21, expected_params
+      expect(a_get(expected_resource).with(:query => expected_params)).to have_been_made
+    end
+
+    it "returns Viagogo::Page created from the response" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      expect(@client.categories_children "GB", 0).to be_an_instance_of(Viagogo::Page)
+    end
+  end
+end

data/spec/viagogo/public/api/countries_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Viagogo::Public::API::Countries do
+  before do
+    @client = Viagogo::Public::Client.new(:consumer_key => 'CK',
+                                          :consumer_secret => 'CS',
+                                          :access_token => 'AT',
+                                          :access_token_secret => 'AS')
+  end
+
+  describe "#country" do
+    it "makes HTTP get request" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      @client.country "BB"
+      expect(a_request(:get, /.*/)).to have_been_made
+    end
+
+    it "makes request for the correct resource" do
+      expected_resource = "US"
+      expected_params = {:foo => "foo", :bar => "bar"}
+      stub_get("/Public/Country/#{expected_resource}").
+          with(:query => expected_params).
+          to_return(:body => "{}")
+      @client.country expected_resource, expected_params
+      expect(a_get("/Public/Country/#{expected_resource}").with(:query => expected_params)).to have_been_made
+    end
+
+    it "returns Viagogo::Country created from the response" do
+      stub_get("/Public/Country/GB").to_return({:body => "{\"name\":\"GB\"}"})
+      expect(@client.country "GB").to be_an_instance_of(Viagogo::Country)
+    end
+  end
+
+  describe "#countries" do
+    it "makes HTTP get request" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      @client.countries
+      expect(a_request(:get, /.*/)).to have_been_made
+    end
+
+    it "makes request for the correct resource" do
+      expected_resource = "/Public/Country/All"
+      expected_params = {:foo => "foo", :bar => "bar"}
+      stub_get(expected_resource).with(:query => expected_params).to_return(:body => "{}")
+      @client.countries expected_params
+      expect(a_get(expected_resource).with(:query => expected_params)).to have_been_made
+    end
+
+    it "returns Viagogo::Page created from the response" do
+      stub_get("/Public/Country/All").to_return({:body => "{}"})
+      expect(@client.countries).to be_an_instance_of(Viagogo::Page)
+    end
+  end
+end

data/spec/viagogo/public/api/events_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+describe Viagogo::Public::API::Events do
+  before do
+    @client = Viagogo::Public::Client.new(:consumer_key => 'CK',
+                                          :consumer_secret => 'CS',
+                                          :access_token => 'AT',
+                                          :access_token_secret => 'AS')
+  end
+
+  describe "#event" do
+    it "makes HTTP get request" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      @client.event 1
+      expect(a_request(:get, /.*/)).to have_been_made
+    end
+
+    it "makes request for the correct resource" do
+      expected_resource = 50
+      expected_params = {:foo => "foo", :bar => "bar"}
+      stub_get("/Public/Event/#{expected_resource}").
+          with(:query => expected_params).
+          to_return(:body => "{}")
+      @client.event expected_resource, expected_params
+      expect(a_get("/Public/Event/#{expected_resource}").with(:query => expected_params)).to have_been_made
+    end
+
+    it "returns Viagogo::Event created from the response" do
+      stub_get("/Public/Event/1").to_return({:body => "{\"Id\": 5}"})
+      expect(@client.event 1).to be_an_instance_of(Viagogo::Event)
+    end
+  end
+
+  describe "#events_by_category" do
+    it "makes HTTP get request" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      @client.events_by_category 2
+      expect(a_request(:get, /.*/)).to have_been_made
+    end
+
+    it "makes request for the correct resource" do
+      expected_resource = "/Public/Event/ByCategory/50"
+      expected_params = {:foo => "foo", :bar => "bar"}
+      stub_get(expected_resource).with(:query => expected_params).to_return(:body => "{}")
+      @client.events_by_category 50, expected_params
+      expect(a_get(expected_resource).with(:query => expected_params)).to have_been_made
+    end
+
+    it "returns Viagogo::Page created from the response" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      expect(@client.events_by_category 20).to be_an_instance_of(Viagogo::Page)
+    end
+  end
+
+  describe "#events_by_metro_area" do
+    it "makes HTTP get request" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      @client.events_by_metro_area 2
+      expect(a_request(:get, /.*/)).to have_been_made
+    end
+
+    it "makes request for the correct resource" do
+      expected_resource = "/Public/Event/ByMetroArea/50"
+      expected_params = {:foo => "foo", :bar => "bar"}
+      stub_get(expected_resource).with(:query => expected_params).to_return(:body => "{}")
+      @client.events_by_metro_area 50, expected_params
+      expect(a_get(expected_resource).with(:query => expected_params)).to have_been_made
+    end
+
+    it "returns Viagogo::Page created from the response" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      expect(@client.events_by_metro_area 20).to be_an_instance_of(Viagogo::Page)
+    end
+  end
+
+  describe "#events_by_venue" do
+    it "makes HTTP get request" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      @client.events_by_venue 2
+      expect(a_request(:get, /.*/)).to have_been_made
+    end
+
+    it "makes request for the correct resource" do
+      expected_resource = "/Public/Event/ByVenue/50"
+      expected_params = {:foo => "foo", :bar => "bar"}
+      stub_get(expected_resource).with(:query => expected_params).to_return(:body => "{}")
+      @client.events_by_venue 50, expected_params
+      expect(a_get(expected_resource).with(:query => expected_params)).to have_been_made
+    end
+
+    it "returns Viagogo::Page created from the response" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      expect(@client.events_by_venue 20).to be_an_instance_of(Viagogo::Page)
+    end
+  end
+
+  describe "#events_by_utc_start_date" do
+    it "makes HTTP get request" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      @client.events_by_utc_start_date 2000, 1, 1
+      expect(a_request(:get, /.*/)).to have_been_made
+    end
+
+    it "makes request for the correct resource" do
+      expected_resource = "/Public/Event/ByUtcStartDate/2003/3/15"
+      expected_params = {:foo => "foo", :bar => "bar"}
+      stub_get(expected_resource).with(:query => expected_params).to_return(:body => "{}")
+      @client.events_by_utc_start_date 2003, 3, 15, expected_params
+      expect(a_get(expected_resource).with(:query => expected_params)).to have_been_made
+    end
+
+    it "returns Viagogo::Page created from the response" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      expect(@client.events_by_utc_start_date 2011, 11, 11).to be_an_instance_of(Viagogo::Page)
+    end
+  end
+
+  describe "#events_search" do
+    it "makes HTTP get request" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      @client.events_search "foo"
+      expect(a_request(:get, /.*/)).to have_been_made
+    end
+
+    it "makes request for the correct resource" do
+      expected_resource = "/Public/Event/Search"
+      expected_params = {:searchText => "some query", :foo => "foo", :bar => "bar"}
+      stub_get(expected_resource).with(:query => expected_params).to_return(:body => "{}")
+      @client.events_search expected_params[:searchText], expected_params
+      expect(a_get(expected_resource).with(:query => expected_params)).to have_been_made
+    end
+
+    it "returns Viagogo::Page created from the response" do
+      stub_request(:any, /.*/).to_return(:body => "{}")
+      expect(@client.events_search "foo").to be_an_instance_of(Viagogo::Page)
+    end
+  end
+end