singleplatform 0.1.1 → 0.2.2

data/lib/singleplatform/version.rb

@@ -1,3 +1,3 @@
 module Singleplatform
-  VERSION = '0.1.1'
+  VERSION = '0.2.2'
 end

data/spec/singleplatform/client/locations_spec.rb

@@ -0,0 +1,87 @@
+require 'singleplatform'
+require 'webmock/rspec'
+require 'spec_helper'
+
+describe 'Singleplatform::Client::Locations' do
+
+  before do
+    @creds = {
+      client_id:     'purplespacesuitfrogboots1',
+      client_secret: 'yellowsubmarinesresonatewithmeandmybestbros'
+    }
+    @client = Singleplatform::Client.new(@creds)
+    @location = File.open(Dir.pwd + '/spec/support/fixtures/location.json').read
+    @updated_since = File.open(Dir.pwd + '/spec/support/fixtures/updated_since.json').read
+  end
+
+  describe ".location" do
+    context "when given a valid location id" do
+      it "returns data for that location" do
+        stub_request(:get, /publishing-api.singleplatform.com/).
+          with(headers: {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+          to_return(status: 200, body: @location)
+        response = @client.location('island-prime')
+        expect(response).to be_a(Singleplatform::Response)
+        expect(response.body.location_id).to eql('island-prime')
+      end
+    end
+
+    context "when missing a location id" do
+      it "raises an ArgumentError" do
+        expect { @client.location }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "when including too many params" do
+      it "raises an ArgumentError" do
+        expect { @client.location('island-prime', 'another-argument') }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "when given an invalid location id" do
+      it "raises an InvalidLocationError" do
+        expect { @client.location('') }.to raise_error(Singleplatform::Error::InvalidLocationError)
+        expect { @client.location(' ') }.to raise_error(Singleplatform::Error::InvalidLocationError)
+      end
+    end
+  end
+
+  describe ".locations_updated_since" do
+    context "when given a valid date" do
+      it "returns locations updated since that date" do
+        stub_request(:get, /publishing-api.singleplatform.com/).
+          with(headers: {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+          to_return(status: 200, body: @updated_since)
+        response = @client.locations_updated_since('2012-01-01', limit: 3)
+        expect(response).to be_a(Singleplatform::Response)
+        expect(response.body.results.size).to eql(3)
+      end
+    end
+
+    context "when missing a date" do
+      it "raises an ArgumentError" do 
+        expect { @client.locations_updated_since }.to raise_error(ArgumentError
+          )
+      end
+    end
+
+    context "when given an invalid date" do
+      it "raises an InvalidDateError" do
+        expect { @client.locations_updated_since(' ') }.to raise_error(Singleplatform::Error::InvalidDateError)
+        expect { @client.locations_updated_since('2016') }.to raise_error(Singleplatform::Error::InvalidDateError)
+        expect { @client.locations_updated_since('2016-9') }.to raise_error(Singleplatform::Error::InvalidDateError)
+        expect { @client.locations_updated_since('2016-9-') }.to raise_error(Singleplatform::Error::InvalidDateError)
+        expect { @client.locations_updated_since('2016-9-31') }.to raise_error(Singleplatform::Error::InvalidDateError)
+      end
+    end
+  end
+
+  describe ".all" do
+    context "when given a valid location id" do
+      it "returns location info, menus and photos" do
+        # TODO
+      end
+    end
+  end
+  
+end

data/spec/singleplatform/client/menus_spec.rb

@@ -0,0 +1,41 @@
+require 'singleplatform'
+require 'webmock/rspec'
+
+describe Singleplatform::Client::Menus do
+
+  before do
+    @creds = {
+      client_id:     'purplespacesuitfrogboots1',
+      client_secret: 'yellowsubmarinesresonatewithmeandmybestbros'
+    }
+    @client = Singleplatform::Client.new(@creds)
+    @menus = File.open(Dir.pwd + '/spec/support/fixtures/menus.json').read
+  end
+
+  describe ".menus_for" do
+    context "when given a valid location id" do
+      it "returns menu data for that location" do
+        stub_request(:get, /publishing-api.singleplatform.com/).
+          with(headers: {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+          to_return(status: 200, body: @menus)
+        response = @client.menus_for('island-prime')
+        expect(response).to be_a(Singleplatform::Response)
+        expect(response.body.size).to eql(2)
+      end
+    end
+
+    context "when missing a location id" do
+      it "raises an ArgumentError" do
+        expect { @client.menus_for }.to raise_error(ArgumentError) 
+      end
+    end
+
+    context "when given an invalid location id" do
+      it "raises an InvalidLocationError" do
+        expect { @client.menus_for('') }.to raise_error(Singleplatform::Error::InvalidLocationError)
+        expect { @client.menus_for(' ') }.to raise_error(Singleplatform::Error::InvalidLocationError)
+      end
+    end
+  end
+
+end

data/spec/singleplatform/client/photos_spec.rb

@@ -0,0 +1,41 @@
+require 'singleplatform'
+require 'webmock/rspec'
+
+describe Singleplatform::Client::Photos do
+
+  before do
+    @creds = {
+      client_id:     'purplespacesuitfrogboots1',
+      client_secret: 'yellowsubmarinesresonatewithmeandmybestbros'
+    }
+    @client = Singleplatform::Client.new(@creds)
+    @photos = File.open(Dir.pwd + '/spec/support/fixtures/photos.json').read
+  end
+
+  describe ".photos_for" do
+    context "when given a valid location id" do
+      it "returns photos for that location" do
+        stub_request(:get, /publishing-api.singleplatform.com/).
+          with(headers: {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+          to_return(status: 200, body: @photos)
+          response = @client.photos_for('island-prime')
+          expect(response).to be_a(Singleplatform::Response)
+          expect(response.body.first.title).to eql('Key Lime Pie')
+      end
+    end
+    
+    context "when missing a location id" do
+      it "raises an ArgumentError" do
+        expect { @client.photos_for }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "when given an invalid location id" do
+      it "raises an InvalidLocationError" do
+        expect { @client.photos_for('') }.to raise_error(Singleplatform::Error::InvalidLocationError)
+        expect { @client.photos_for(' ') }.to raise_error(Singleplatform::Error::InvalidLocationError)
+      end
+    end
+  end
+
+end

data/spec/singleplatform/client_spec.rb

@@ -0,0 +1,37 @@
+require 'singleplatform'
+
+describe Singleplatform::Client do
+  before do
+    @creds = {
+      client_id:     'purplespacesuitfrogboots1',
+      client_secret: 'yellowsubmarinesresonatewithmeandmybestbros'
+    }
+    @path   = '/locations/updated_since/'
+    @params = { date: '2016-08-01', limit: 100 }
+    @client = Singleplatform::Client.new(@creds)
+    @url = 'http://publishing-api.singleplatform.com/locations/updated_since/?date=2016-08-01&limit=100&client=purplespacesuitfrogboots1&signature=D4mf0vL2jwJKU02OawPlXFXQymg%3D'
+  end
+
+  describe ".new" do
+    context "given API credentials" do
+      it "returns a Singleplatform::Client object" do
+        expect(Singleplatform.new(@creds)).to be_a(Singleplatform::Client)
+      end
+    end
+
+    context "without API credentials" do
+      it "raises a MissingCredentialsError" do
+        expect { Singleplatform.new }.
+          to raise_error(Singleplatform::Error::MissingCredentialsError)
+      end
+    end
+  end
+
+  describe ".generate_url" do
+    context "given a valid path and params" do
+      it "correctly generates a URL" do
+        expect(@client.generate_url(@path, @params)).to eql(@url)
+      end
+    end
+  end
+end

data/spec/singleplatform_spec.rb

@@ -0,0 +1,27 @@
+require 'singleplatform'
+require 'spec_helper'
+
+describe Singleplatform do
+
+  before do
+    @creds = {
+      client_id:     'purplespacesuitfrogboots1',
+      client_secret: 'yellowsubmarinesresonatewithmeandmybestbros'
+    }
+  end
+
+  describe ".new" do
+    context "given API credentials" do
+      it "returns a Singleplatform::Client object" do
+        expect(Singleplatform.new(@creds)).to be_a(Singleplatform::Client)
+      end
+    end
+
+    context "without API credentials" do
+      it "raises a MissingCredentialsError" do
+        expect { Singleplatform.new }.
+          to raise_error(Singleplatform::Error::MissingCredentialsError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+# RSpec.configure do |config|
+#   config.before(:each) do
+    
+#   end
+# end

data/spec/support/fixtures/location.json

@@ -0,0 +1,114 @@
+{
+   "data" : {
+      "updated" : "2014-03-31T14:28:42",
+      "published_at" : "2013-09-06T12:14:53",
+      "is_owner_verified" : true,
+      "out_of_business" : false,
+      "phone" : "619-298-6802",
+      "email" : "info@dinecrg.com",
+      "location" : {
+         "postal_code" : "92101",
+         "directions" : "Across from the San Diego International Airport (Terminal 1).  Next to the Sunroad Marina.",
+         "country" : "US",
+         "neighborhood" : "Harbor Island",
+         "state" : "CA",
+         "longitude" : -117.19511,
+         "latitude" : 32.72495,
+         "cross_street" : "N Harbor Drive",
+         "city" : "San Diego",
+         "address1" : "880 Harbor Island Dr",
+         "address2" : "Test Suit"
+      },
+      "foreign_ids" : {
+         "facebook" : "467871149918479",
+         "yelp" : "sNhSsshDp5fuIhjl99tfng",
+         "foursquare" : "48331810f964a520e24f1fe3"
+      },
+      "hours" : {
+         "Wednesday" : [
+            {
+               "closing" : "09:00pm",
+               "opening" : "11:30am",
+               "description" : ""
+            }
+         ],
+         "Saturday" : [
+            {
+               "description" : "",
+               "opening" : "11:30am",
+               "closing" : "10:00pm"
+            }
+         ],
+         "Sunday" : [
+            {
+               "closing" : "09:30pm",
+               "description" : "",
+               "opening" : "11:30am"
+            }
+         ],
+         "Monday" : [
+            {
+               "closing" : "09:00pm",
+               "description" : "",
+               "opening" : "11:30am"
+            }
+         ],
+         "Tuesday" : [
+            {
+               "description" : "",
+               "opening" : "11:30am",
+               "closing" : "09:00pm"
+            }
+         ],
+         "Thursday" : [
+            {
+               "opening" : "11:30am",
+               "description" : "",
+               "closing" : "09:00pm"
+            }
+         ],
+         "Friday" : [
+            {
+               "closing" : "10:00pm",
+               "opening" : "11:30am",
+               "description" : ""
+            }
+         ]
+      },
+      "created" : "2011-12-01T00:00:00",
+      "location_id" : "island-prime",
+      "description" : "Resting on stilts atop San Diego Bay overlooking the city skyline and Coronado, there",
+      "name" : "Island Prime",
+      "website" : "http://www.islandprime.com/",
+      "attributes" : {
+         "delivery" : true,
+         "alcohol" : "Full Bar",
+         "cuisine" : [
+            "American - Contemporary",
+            "American - Traditional",
+            "Seafood",
+            "Steakhouse"
+         ],
+         "wheelchair_access" : true,
+         "drive_thru" : true,
+         "reservations" : true,
+         "dine_in" : true,
+         "catering" : true,
+         "meals_served" : [
+            "Lunch",
+            "Dinner"
+         ],
+         "payment_types_accepted" : [
+            "All Major Cards"
+         ],
+         "take_out" : true,
+         "price_rating" : "3",
+         "average_price" : "12"
+      },
+      "time_zone" : "PST",
+      "business_type" : "Restaurant",
+      "is_published" : true,
+      "has_photos" : true
+   },
+   "code" : 200
+}

data/spec/support/fixtures/menus.json

@@ -0,0 +1,374 @@
+{
+   "data" : [
+      {
+         "attribution_image" : "http://a.singleplatform.com/sp/island-prime/provided_by_2.png",
+         "location_id" : "island-prime",
+         "footnote" : "",
+         "currency" : "USD",
+         "description" : "",
+         "sections" : [
+            {
+               "items" : [
+                  {
+                     "additions" : [],
+                     "id" : 25765840,
+                     "order_num" : 0,
+                     "name" : "Island Prime's Lobster Bisque",
+                     "photos" : [],
+                     "description" : "sherry, cream & lobster",
+                     "attributes" : {},
+                     "choices" : [
+                        {
+                           "calories" : {
+                              "max" : "",
+                              "min" : ""
+                           },
+                           "prices" : {
+                              "min" : 12,
+                              "max" : 13
+                           },
+                           "order_num" : 0,
+                           "name" : "",
+                           "unit" : ""
+                        }
+                     ]
+                  },
+                  {
+                     "choices" : [
+                        {
+                           "calories" : {
+                              "min" : "",
+                              "max" : ""
+                           },
+                           "prices" : {
+                              "max" : 18,
+                              "min" : 18
+                           },
+                           "name" : "",
+                           "order_num" : 0,
+                           "unit" : ""
+                        }
+                     ],
+                     "attributes" : {},
+                     "description" : "blue crab salad, avocado, \npapaya-mango salsa, taro chips & caviar",
+                     "photos" : [
+                        {
+                           "title" : "Seared Ahi Stack",
+                           "type" : "Product",
+                           "url" : "https://d3lawkbdj6aabd.cloudfront.net/singleplatform/image/upload/a3b8de0f48c57ea83c252c7e34f5f3cef919f2f1.jpg",
+                           "source" : "singleplatform",
+                           "photo_id" : "a3b8de0f48c57ea83c252c7e34f5f3cef919f2f1"
+                        }
+                     ],
+                     "name" : "Seared Ahi Stack",
+                     "order_num" : 1,
+                     "id" : 25765874,
+                     "additions" : []
+                  }
+               ],
+               "order_num" : 0,
+               "name" : "Appetizers From The Sea",
+               "description" : "",
+               "id" : 3497452
+            },
+            {
+               "items" : [
+                  {
+                     "choices" : [
+                        {
+                           "calories" : {
+                              "min" : "",
+                              "max" : ""
+                           },
+                           "order_num" : 0,
+                           "name" : "8oz",
+                           "unit" : "",
+                           "prices" : {
+                              "min" : 36,
+                              "max" : 36
+                           }
+                        },
+                        {
+                           "prices" : {
+                              "min" : 45,
+                              "max" : 45
+                           },
+                           "unit" : "",
+                           "order_num" : 0,
+                           "name" : "12oz",
+                           "calories" : {
+                              "max" : "",
+                              "min" : ""
+                           }
+                        }
+                     ],
+                     "description" : "",
+                     "attributes" : {},
+                     "photos" : [],
+                     "additions" : [],
+                     "name" : "\"CAB\" Center Cut Filet Mignon",
+                     "order_num" : 0,
+                     "id" : 25765950
+                  },
+                  {
+                     "choices" : [
+                        {
+                           "calories" : {
+                              "max" : "",
+                              "min" : ""
+                           },
+                           "unit" : "",
+                           "name" : "",
+                           "order_num" : 0,
+                           "prices" : {
+                              "max" : 45,
+                              "min" : 45
+                           }
+                        }
+                     ],
+                     "attributes" : {},
+                     "description" : "16oz",
+                     "photos" : [],
+                     "additions" : [],
+                     "id" : 25765961,
+                     "order_num" : 1,
+                     "name" : "\"CAB\" Center Cut New York"
+                  }
+               ],
+               "description" : "Our Steaks Are Hand Selected & Cut To Chef Deborah's Specifications",
+               "name" : "Island Prime Artisan Steaks",
+               "order_num" : 1,
+               "id" : 3497473
+            },
+            {
+               "items" : [
+                  {
+                     "description" : "seabeans, roasted pineapple salsa, yuzu beurre blanc",
+                     "attributes" : {},
+                     "choices" : [
+                        {
+                           "calories" : {
+                              "min" : "",
+                              "max" : ""
+                           },
+                           "unit" : "",
+                           "name" : "",
+                           "order_num" : 0,
+                           "prices" : {
+                              "max" : 32,
+                              "min" : 32
+                           }
+                        }
+                     ],
+                     "additions" : [],
+                     "name" : "Macadamia Crusted Seabass",
+                     "order_num" : 0,
+                     "id" : 25766096,
+                     "photos" : []
+                  },
+                  {
+                     "attributes" : {},
+                     "description" : "black linguini, cucumber salsa, dill moleta & chipotle cream",
+                     "choices" : [
+                        {
+                           "calories" : {
+                              "max" : "",
+                              "min" : ""
+                           },
+                           "name" : "",
+                           "order_num" : 0,
+                           "unit" : "",
+                           "prices" : {
+                              "min" : 32,
+                              "max" : 32
+                           }
+                        }
+                     ],
+                     "additions" : [],
+                     "id" : 25766102,
+                     "name" : "Indigo Grill's Cedar Plank Salmon",
+                     "order_num" : 1,
+                     "photos" : [
+                        {
+                           "title" : "Indigo Grill's Cedar Plank Salmon",
+                           "type" : "unclassified",
+                           "url" : "https://d3lawkbdj6aabd.cloudfront.net/singleplatform/image/upload/0cec0bda6bcf6cd598e5a98856decf0473e1040c.jpg",
+                           "source" : "singleplatform",
+                           "photo_id" : "0cec0bda6bcf6cd598e5a98856decf0473e1040c"
+                        }
+                     ]
+                  },
+                  {
+                     "description" : "baked potato & brown butter broccoli",
+                     "attributes" : {},
+                     "choices" : [
+                        {
+                           "name" : "",
+                           "order_num" : 0,
+                           "unit" : "",
+                           "prices" : {
+                              "min" : 48,
+                              "max" : 48
+                           },
+                           "calories" : {
+                              "min" : "",
+                              "max" : ""
+                           }
+                        }
+                     ],
+                     "additions" : [],
+                     "order_num" : 2,
+                     "name" : "1lb Alaskan King Crab Legs",
+                     "id" : 25766162,
+                     "photos" : []
+                  }
+               ],
+               "id" : 3497500,
+               "order_num" : 2,
+               "name" : "Deborah's Compositions",
+               "description" : ""
+            }
+         ],
+         "attribution_image_link" : "http://www.singleplatform.com/partner-lp?ref=sp&sp_channel=viral&sp_source=publisher&sp_campaign=sp",
+         "secure_attribution_image_link" : "https://www.singleplatform.com/partner-lp?ref=sp&sp_channel=viral&sp_source=publisher&sp_campaign=sp",
+         "updated" : "2014-03-31T14:28:42",
+         "secure_attribution_image" : "https://as.singleplatform.com/sp/island-prime/provided_by_2.png",
+         "id" : 617618,
+         "created" : "2012-08-23T18:03:04",
+         "order_num" : 0,
+         "name" : "Island Prime",
+         "menu_type" : "Menu"
+      },
+      {
+         "updated" : "2013-11-23T17:50:06",
+         "secure_attribution_image" : "https://as.singleplatform.com/sp/island-prime/provided_by_2.png",
+         "created" : "2013-11-23T17:50:06",
+         "name" : "Dessert",
+         "order_num" : 5,
+         "id" : 935054,
+         "menu_type" : "Menu",
+         "attribution_image" : "http://a.singleplatform.com/sp/island-prime/provided_by_2.png",
+         "location_id" : "island-prime",
+         "currency" : "USD",
+         "description" : "",
+         "footnote" : "",
+         "secure_attribution_image_link" : "https://www.singleplatform.com/partner-lp?ref=sp&sp_channel=viral&sp_source=publisher&sp_campaign=sp",
+         "attribution_image_link" : "http://www.singleplatform.com/partner-lp?ref=sp&sp_channel=viral&sp_source=publisher&sp_campaign=sp",
+         "sections" : [
+            {
+               "items" : [
+                  {
+                     "photos" : [],
+                     "additions" : [],
+                     "order_num" : 0,
+                     "name" : "Potted Brownie Banana Split",
+                     "id" : 38071826,
+                     "choices" : [
+                        {
+                           "unit" : "",
+                           "name" : "",
+                           "order_num" : 0,
+                           "prices" : {
+                              "max" : 10,
+                              "min" : 10
+                           },
+                           "calories" : {
+                              "max" : "",
+                              "min" : ""
+                           }
+                        }
+                     ],
+                     "description" : "homemade peanut butter ice cream over a warm brownie with butterscotch fudge & bruleed bananas",
+                     "attributes" : {}
+                  },
+                  {
+                     "choices" : [
+                        {
+                           "calories" : {
+                              "min" : "",
+                              "max" : ""
+                           },
+                           "unit" : "",
+                           "name" : "",
+                           "order_num" : 0,
+                           "prices" : {
+                              "max" : 10,
+                              "min" : 10
+                           }
+                        }
+                     ],
+                     "description" : "rich lime custard baked in a graham cracker crust, finished with meringue & pomegranate coulis",
+                     "attributes" : {},
+                     "photos" : [
+                        {
+                           "title" : "Key Lime Pie",
+                           "type" : "unclassified",
+                           "source" : "singleplatform",
+                           "url" : "https://d3lawkbdj6aabd.cloudfront.net/singleplatform/image/upload/e8adb3eebbdfd228adddde03d20eac16cda3b253.jpg",
+                           "photo_id" : "e8adb3eebbdfd228adddde03d20eac16cda3b253"
+                        }
+                     ],
+                     "additions" : [],
+                     "order_num" : 1,
+                     "name" : "Key Lime Pie",
+                     "id" : 38071828
+                  },
+                  {
+                     "additions" : [],
+                     "id" : 38071832,
+                     "name" : "Retro Island Prime Mud Pie",
+                     "order_num" : 2,
+                     "photos" : [],
+                     "attributes" : {},
+                     "description" : "mountains of coffee ice cream over a chocolate ganache, homemade fudge",
+                     "choices" : [
+                        {
+                           "calories" : {
+                              "max" : "",
+                              "min" : ""
+                           },
+                           "unit" : "",
+                           "order_num" : 0,
+                           "name" : "",
+                           "prices" : {
+                              "min" : 10,
+                              "max" : 10
+                           }
+                        }
+                     ]
+                  },
+                  {
+                     "description" : "seasonal selections: raspberry white chocolate with a raspberry white chocolate cookie | apricot chai with apricot biscotti | vanilla bean with a mint sprig and icebox cookie",
+                     "attributes" : {},
+                     "choices" : [
+                        {
+                           "prices" : {
+                              "min" : 10,
+                              "max" : 10
+                           },
+                           "order_num" : 0,
+                           "name" : "",
+                           "unit" : "",
+                           "calories" : {
+                              "max" : "",
+                              "min" : ""
+                           }
+                        }
+                     ],
+                     "additions" : [],
+                     "name" : "Trio of Brulees",
+                     "order_num" : 3,
+                     "id" : 38071827,
+                     "photos" : []
+                  }
+               ],
+               "id" : 5452113,
+               "order_num" : 0,
+               "name" : "Desserts",
+               "description" : ""
+            }
+         ]
+      }
+   ],
+   "code" : 200
+}