citygrid_api 0.0.1 → 0.0.2

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/citygrid_api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{citygrid_api}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Elpizo Choi"]
-  s.date = %q{2011-06-24}
+  s.date = %q{2011-07-14}
   s.description = %q{Ruby wrapper for CityGrid APIs}
   s.email = %q{fu7iin@gmail.com}
   s.extra_rdoc_files = [
@@ -26,6 +26,12 @@ Gem::Specification.new do |s|
     "VERSION",
     "citygrid_api.gemspec",
     "lib/citygrid.rb",
+    "lib/citygrid/abstraction.rb",
+    "lib/citygrid/abstraction/collection.rb",
+    "lib/citygrid/abstraction/item.rb",
+    "lib/citygrid/abstraction/requestable.rb",
+    "lib/citygrid/abstraction/super_array.rb",
+    "lib/citygrid/abstraction/super_hash.rb",
     "lib/citygrid/api.rb",
     "lib/citygrid/api/base.rb",
     "lib/citygrid/api/content.rb",
@@ -35,15 +41,11 @@ Gem::Specification.new do |s|
     "lib/citygrid/api/content/places/search.rb",
     "lib/citygrid/api/content/reviews.rb",
     "lib/citygrid/api/response.rb",
+    "lib/citygrid/details.rb",
     "lib/citygrid/listing.rb",
-    "lib/citygrid/listing/details.rb",
-    "lib/citygrid/listing/extend.rb",
-    "lib/citygrid/listing/extend/attribute.rb",
-    "lib/citygrid/listing/extend/attributes.rb",
-    "lib/citygrid/listing/extend/requestable.rb",
-    "lib/citygrid/listing/offers.rb",
-    "lib/citygrid/listing/reviews.rb",
-    "lib/citygrid/super_hash.rb",
+    "lib/citygrid/offers.rb",
+    "lib/citygrid/reviews.rb",
+    "lib/citygrid/search.rb",
     "lib/citygrid_api.rb",
     "test/helper.rb",
     "test/publisher_helper.rb.sample",

data/lib/citygrid/abstraction/collection.rb

@@ -0,0 +1,15 @@
+class CityGrid
+  module Abstraction
+    class Collection < SuperArray
+      include Requestable
+
+      def self.new opts = {}
+        self[].request_and_update opts
+      end
+
+      def update array
+        replace array
+      end
+    end
+  end
+end

data/lib/citygrid/abstraction/item.rb

@@ -0,0 +1,11 @@
+class CityGrid
+  module Abstraction
+    class Item < SuperHash
+      include Requestable
+
+      def self.new opts = {}
+        self[{}].request_and_update opts
+      end
+    end
+  end
+end

data/lib/citygrid/abstraction/requestable.rb

@@ -0,0 +1,38 @@
+class CityGrid
+  module Abstraction
+    module Requestable
+      def self.included base
+        base.instance_eval do
+          attr_reader :raw
+        end
+      end
+
+      def api
+        # set corresponding API here
+      end
+
+      def request opts = {}
+        api.request opts
+      end
+
+      # Run request, preprocess, and update.
+      # Write an update method if it doesn't already exist
+      #
+      # def update
+      #
+      # end
+      def request_and_update opts = {}
+        @raw = request opts
+        update preprocess(@raw)
+      end
+
+      private
+
+      # Preprocess request.
+      # Overwrite this method to preprocess request before updating.
+      def preprocess response
+        response
+      end
+    end
+  end
+end

data/lib/citygrid/abstraction/super_array.rb

@@ -0,0 +1,22 @@
+# Extend Array to provide following features:
+# - creates SuperHash for hashes
+# - creates SuperArray for arrays
+# ------------------------------- #
+class CityGrid
+  module Abstraction
+    class SuperArray < Array
+      def self.new objs
+        array = self.[] objects
+        array.map! do |obj|
+          if obj.class == Hash
+            SuperHash.new obj
+          elsif obj.class == Array
+            new obj
+          else
+            obj
+          end
+        end
+      end
+    end
+  end
+end

data/lib/citygrid/abstraction/super_hash.rb

@@ -0,0 +1,26 @@
+# Extend Hash to provide following features:
+# - create by SuperHash.new(<hash>)
+# - can access values by method, instead of []
+# -------------------------------------------- #
+class CityGrid
+  module Abstraction
+    class SuperHash < Hash
+      def self.new attrs
+        self[attrs]
+      end
+
+      def method_missing sym, *args, &block
+        val = self[sym] || self[sym.to_s]
+
+        # create new SuperHash if value is hash
+        if val.is_a? Hash
+          SuperHash.new val
+        elsif keys.include?(sym) || keys.include?(sym.to_s)
+          val
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/citygrid/abstraction.rb

@@ -0,0 +1,3 @@
+%w{super_hash super_array requestable item collection}.each do |abs|
+  require "citygrid/abstraction/#{abs}"
+end

data/lib/citygrid/api/base.rb

@@ -24,9 +24,14 @@ class CityGrid
         end
 
         def request options = {}
-          query    = options.merge :publisher => publisher, :format => "json"
+          query = options.merge :publisher => publisher, :format => "json"
           response = get endpoint, :query => query
-          CityGrid::API::Response.new response
+
+          if response["errors"].empty?
+            CityGrid::API::Response.new response
+          else
+            raise Error.new response["errors"], response
+          end
         end
 
         private
@@ -40,5 +45,16 @@ class CityGrid
         end
       end
     end
+
+    # Throws error with message from API
+    # HTTParty response is available if this class is rescued
+    class Error < StandardError
+      attr_reader :httparty
+
+      def initialize errors, response = nil
+        @httparty = response
+        super errors.first["error"]
+      end
+    end
   end
 end

data/lib/citygrid/api/content/places/search.rb

@@ -9,36 +9,6 @@ class CityGrid
             def endpoint
               "/places/v2/search/where"
             end
-
-            # Overwrite to return Search::Response
-            def request options
-              query    = options.merge :publisher => publisher, :format => "json"
-              response = get endpoint, :query => query
-              Response.new response
-            end
-          end
-
-          # Holds array of Listings.
-          # HTTParty response can be accessed by #response
-          # ---------------------------------------------- #
-          class Response < Array
-            attr_reader :response, :errors
-
-            def self.new httparty_response
-              resp  = httparty_response.parsed_response
-
-              if resp["errors"]
-                array = self.[]
-                array.instance_variable_set "@errors", resp["errors"]
-              else
-                array = self.[] *resp["results"]["locations"]
-                array.map! do |result|
-                  CityGrid::Listing.new result
-                end
-              end
-              array.instance_variable_set "@response", httparty_response
-              array
-            end
           end
         end
       end

data/lib/citygrid/api/response.rb

@@ -1,16 +1,14 @@
-require "citygrid/super_hash"
-
 class CityGrid
   module API
     # Creates SuperHash from parsed_response
     # Stores response object in @response.
     # ------------------------------------ #
-    class Response < CityGrid::SuperHash
-      attr_reader :response
+    class Response < CityGrid::Abstraction::SuperHash
+      attr_reader :httparty
 
       def self.new httparty_response
         resp = super httparty_response.parsed_response
-        resp.instance_variable_set "@response", httparty_response
+        resp.instance_variable_set "@httparty", httparty_response
         resp
       end
     end

data/lib/citygrid/details.rb

@@ -0,0 +1,17 @@
+class CityGrid
+  class Details < Abstraction::Item
+    def api
+      CityGrid::API::Content::Places::Detail
+    end
+
+    def request opts = {}
+      api.request opts.merge(:client_ip => "192.168.0.1")
+    end
+
+    private
+
+    def preprocess response
+      response.locations.first
+    end
+  end
+end

data/lib/citygrid/listing.rb

@@ -1,11 +1,5 @@
-require "citygrid/super_hash"
-require "citygrid/listing/extend"
-require "citygrid/listing/details"
-require "citygrid/listing/offers"
-require "citygrid/listing/reviews"
-
 class CityGrid
-  class Listing < SuperHash
+  class Listing < Abstraction::SuperHash
 
     def method_missing meth, *args, &block
       load unless @loaded
@@ -18,6 +12,7 @@ class CityGrid
       extend LoadedMethods
       update_details
       @loaded = true
+      self
     end
 
     module LoadedMethods
@@ -44,7 +39,7 @@ class CityGrid
       end
 
       def categories
-        @categories ||= extract_categories details["categories"]
+        @categories ||= extract_categories self["categories"]
       end
 
       def special_features
@@ -56,31 +51,33 @@ class CityGrid
       end
 
       def attributes
-        @attributes ||= extract_attributes details["attributes"]
+        @attributes ||= extract_attributes self["attributes"]
       end
 
       # Details
       # ---------------- #
       def update_details
-        update Details.new listing_id
+        update Details.new :listing_id => listing_id
       end
 
       # Offers
       # -------------- #
       def offers opts = {}
-        @offers ||= Offers.new listing_id
-        @offers.update_options opts
+        Offers.new listing_options(opts)
       end
 
       # Reviews
       # -------------- #
       def reviews opts = {}
-        @reviews ||= Reviews.new listing_id
-        @reviews.update_options opts
+        Reviews.new listing_options(opts)
       end
 
       private
 
+      def listing_options opts
+        {:listing_id => listing_id}.merge(opts)
+      end
+
       # Group categories by their group names
       def extract_categories cats
         cats.inject Hash.new do |hash, tag|

data/lib/citygrid/offers.rb

@@ -0,0 +1,13 @@
+class CityGrid
+  class Offers < Abstraction::Collection
+    def api
+      CityGrid::API::Content::Offers
+    end
+
+    private
+
+    def preprocess response
+      response.results.offers
+    end
+  end
+end

data/lib/citygrid/reviews.rb

@@ -0,0 +1,17 @@
+class CityGrid
+  class Reviews < Abstraction::Collection
+    def api
+      CityGrid::API::Content::Reviews
+    end
+
+    def total_hits
+      raw["results"]["total_hits"]
+    end
+
+    private
+
+    def preprocess response
+      response.results.reviews
+    end
+  end
+end

data/lib/citygrid/search.rb

@@ -0,0 +1,15 @@
+class CityGrid
+  class Search < Abstraction::Collection
+    def api
+      CityGrid::API::Content::Places::Search
+    end
+
+    private
+
+    def preprocess response
+      response.results.locations.map do |attrs|
+        Listing.new attrs
+      end
+    end
+  end
+end

data/lib/citygrid.rb

@@ -1,6 +1,12 @@
-require "citygrid/listing"
+require "citygrid/abstraction"
 require "citygrid/api"
 
+require "citygrid/search"
+require "citygrid/reviews"
+require "citygrid/offers"
+require "citygrid/details"
+require "citygrid/listing"
+
 class CityGrid
   class << self
     def publisher= code
@@ -12,20 +18,20 @@ class CityGrid
       @@publisher
     end
 
-    def places
-      API::Content::Places
+    def search opts = {}
+      Search.new opts
     end
 
-    def offers opts
-      API::Content::Offers.request opts
+    def find listing_id
+      Listing.new("id" => listing_id).send(:load)
     end
 
-    def reviews opts
-      API::Content::Reviews.request opts
+    def offers opts
+      Offers.new opts
     end
 
-    def search opts = {}
-      places.search opts
+    def reviews opts
+      Reviews.new opts
     end
   end
 

data/test/test_super_hash.rb

@@ -5,7 +5,7 @@ context "A SuperHash" do
   # ------------------------ #
   context "created from #new" do
     context "and given a hash" do
-      setup { CityGrid::SuperHash.new(:test => "wassup") }
+      setup { CityGrid::Abstraction::SuperHash.new(:test => "wassup") }
       should("return a hash") { topic.is_a? Hash }
       should("its value can be accessible through its key") { topic[:test] == "wassup"}
     end
@@ -15,19 +15,19 @@ context "A SuperHash" do
   # ------------------------ #
   context "that's single level" do
     context "with symbol as key" do
-      setup { CityGrid::SuperHash.new(:test => "wassup") }
+      setup { CityGrid::Abstraction::SuperHash.new(:test => "wassup") }
       should("can access key as method") { topic.test }
     end
 
     context "with string as key" do
-      setup { CityGrid::SuperHash.new("test" => "wasssup") }
-      should("can access key as method"){  topic.test }
+      setup { CityGrid::Abstraction::SuperHash.new("test" => "wasssup") }
+      should("can access key as method"){ topic.test }
     end
   end
 
   context "that has a subhash" do
-    setup { CityGrid::SuperHash.new(:test => {:wassup => "hows it going?"}) }
-    should("return another SuperHash") { topic.test.is_a? CityGrid::SuperHash }
+    setup { CityGrid::Abstraction::SuperHash.new(:test => {:wassup => "hows it going?"}) }
+    should("return another SuperHash") { topic.test.is_a? CityGrid::Abstraction::SuperHash }
     should("return correct hash") { topic.test.wassup == "hows it going?" }
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: citygrid_api
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Elpizo Choi
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-24 00:00:00 Z
+date: 2011-07-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -130,6 +130,12 @@ files:
 - VERSION
 - citygrid_api.gemspec
 - lib/citygrid.rb
+- lib/citygrid/abstraction.rb
+- lib/citygrid/abstraction/collection.rb
+- lib/citygrid/abstraction/item.rb
+- lib/citygrid/abstraction/requestable.rb
+- lib/citygrid/abstraction/super_array.rb
+- lib/citygrid/abstraction/super_hash.rb
 - lib/citygrid/api.rb
 - lib/citygrid/api/base.rb
 - lib/citygrid/api/content.rb
@@ -139,15 +145,11 @@ files:
 - lib/citygrid/api/content/places/search.rb
 - lib/citygrid/api/content/reviews.rb
 - lib/citygrid/api/response.rb
+- lib/citygrid/details.rb
 - lib/citygrid/listing.rb
-- lib/citygrid/listing/details.rb
-- lib/citygrid/listing/extend.rb
-- lib/citygrid/listing/extend/attribute.rb
-- lib/citygrid/listing/extend/attributes.rb
-- lib/citygrid/listing/extend/requestable.rb
-- lib/citygrid/listing/offers.rb
-- lib/citygrid/listing/reviews.rb
-- lib/citygrid/super_hash.rb
+- lib/citygrid/offers.rb
+- lib/citygrid/reviews.rb
+- lib/citygrid/search.rb
 - lib/citygrid_api.rb
 - test/helper.rb
 - test/publisher_helper.rb.sample

data/lib/citygrid/listing/details.rb

@@ -1,21 +0,0 @@
-require "citygrid/listing/extend"
-
-class CityGrid
-  class Listing < SuperHash
-    class Details < Extend::Attribute
-      def api
-        CityGrid::API::Content::Places::Detail
-      end
-
-      def request
-        api.request listing_options.merge(:client_ip => "192.168.0.1")
-      end
-
-      private
-
-      def preprocess req
-        req.locations.first
-      end
-    end
-  end
-end

data/lib/citygrid/listing/extend/attribute.rb

@@ -1,18 +0,0 @@
-require "citygrid/listing/extend/requestable"
-
-class CityGrid
-  class Listing < SuperHash
-    module Extend
-      class Attribute < CityGrid::SuperHash
-        include Requestable
-
-        def self.new listing_id, opts = {}
-          hash = self[{}]
-          hash.instance_variable_set "@listing_id", listing_id
-          hash.instance_variable_set "@options", opts
-          hash.request_and_update
-        end
-      end
-    end
-  end
-end

data/lib/citygrid/listing/extend/attributes.rb

@@ -1,22 +0,0 @@
-require "citygrid/listing/extend/requestable"
-
-class CityGrid
-  class Listing < SuperHash
-    module Extend
-      class Attributes < Array
-        include Requestable
-
-        def self.new listing_id, opts = {}
-          hash = self[]
-          hash.instance_variable_set "@listing_id", listing_id
-          hash.instance_variable_set "@options", opts
-          hash.request_and_update
-        end
-
-        def update array
-          replace array
-        end
-      end
-    end
-  end
-end

data/lib/citygrid/listing/extend/requestable.rb

@@ -1,51 +0,0 @@
-class CityGrid
-  class Listing < SuperHash
-    module Extend
-      module Requestable
-        def self.included base
-          base.instance_eval do
-            attr_accessor :options
-            attr_reader :listing_id, :raw
-          end
-        end
-
-        def api
-          # set corresponding API here
-        end
-
-        def request
-          api.request listing_options
-        end
-
-        # Run request, preprocess, and update.
-        # Write an update method if it doesn't already exist
-        #
-        # def update
-        #
-        # end
-        def request_and_update
-          @raw = request
-          update preprocess(@raw)
-        end
-
-        def listing_options
-          options.merge :listing_id => listing_id
-        end
-
-        def update_options opts
-          return self if opts == @options
-          @options = opts
-          request_and_update
-        end
-
-        private
-
-        # Preprocess request.
-        # Overwrite this method to preprocess request before updating.
-        def preprocess req
-          req
-        end
-      end
-    end
-  end
-end

data/lib/citygrid/listing/extend.rb

@@ -1,3 +0,0 @@
-require "citygrid/listing/extend/requestable"
-require "citygrid/listing/extend/attribute"
-require "citygrid/listing/extend/attributes"

data/lib/citygrid/listing/offers.rb

@@ -1,17 +0,0 @@
-require "citygrid/listing/extend"
-
-class CityGrid
-  class Listing < SuperHash
-    class Offers < Extend::Attributes
-      def api
-        CityGrid::API::Content::Offers
-      end
-
-      private
-
-      def preprocess req
-        req.results.offers
-      end
-    end
-  end
-end

data/lib/citygrid/listing/reviews.rb

@@ -1,21 +0,0 @@
-require "citygrid/listing/extend"
-
-class CityGrid
-  class Listing < SuperHash
-    class Reviews < Extend::Attributes
-      def api
-        CityGrid::API::Content::Reviews
-      end
-
-      def total_hits
-        raw["results"]["total_hits"]
-      end
-
-      private
-
-      def preprocess req
-        req.results.reviews
-      end
-    end
-  end
-end

data/lib/citygrid/super_hash.rb

@@ -1,23 +0,0 @@
-class CityGrid
-
-  # Subset of Hash that provides following features:
-  # - create by SuperHash.new(<hash>)
-  # - can access values by method, instead of []
-  # -------------------------------------------- #
-  class SuperHash < Hash
-    def self.new attrs
-      self[attrs]
-    end
-
-    def method_missing sym, *args, &block
-      val = self[sym] || self[sym.to_s]
-
-      # create new SuperHash if value is hash
-      if val.is_a? Hash
-        SuperHash.new val
-      else
-        val || super
-      end
-    end
-  end
-end