rooftop 0.0.6 → 0.0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7b51337bae47ac92f6fb41b5716bbe292f3f19b
-  data.tar.gz: c0ee1e20299e906b1fcf0358e820ddf05ae3d31a
+  metadata.gz: bf9827cc2965fecd6ca71d8ab14d8977e156691b
+  data.tar.gz: 15b808878885da0a5888bd862eae95f5fcf03e46
 SHA512:
-  metadata.gz: 440657fbf5aa59c58464a661e57f04c7459f78b4efe4e7796c0180ed2c6e0064f83097e17cccbb397d5de151636ba128c1f45b06e2c8a443092faf3d3c65d62f
-  data.tar.gz: 2c0e502abd0d09977f803d6354a22b4ae3b762044513d7793847d46d225879e6a1ceb57136b98bbb288fb71fa8629e31bd40d1112bb29b41ac28602126afbf37
+  metadata.gz: 07d4ef3d546e300f33c99887658d0efe9e3a231e13e7f7bd1e519d879d3b64c108ba21ce3e7720eac5e4d1dc534b2780e462b54463624872113e51686aed6825
+  data.tar.gz: d1817d197e0a617c5321a833a6cf547023bdb93ce5ceb80e1cd73904bf8dece8c0d7a243f1e993402d749a5de1bc1378346a8220b39a6feb72657d59bf82dc89

data/lib/rooftop.rb

@@ -9,8 +9,8 @@ module Rooftop
   DEFAULT_API_VERSION = 2
 
   class << self
-    #accessor to set the preview API for use instead of the production one
-    attr_accessor :use_preview_api
+    #accessor to set whether we're in privew mode
+    attr_accessor :preview, :debug_requests, :debug_responses
 
     #access the configuration class as Rooftop.configuration
     attr_accessor :configuration
@@ -25,7 +25,7 @@ module Rooftop
   end
 
   class Configuration
-    attr_accessor :api_token, :url, :site_name, :perform_caching, :cache_store, :cache_logger, :ssl_options, :proxy, :post_type_mapping
+    attr_accessor :api_token, :url, :site_name, :perform_caching, :cache_store, :cache_logger, :ssl_options, :proxy, :post_type_mapping, :logger
     attr_reader :connection,
                 :connection_path,
                 :api_path, #actually writeable with custom setter
@@ -45,16 +45,13 @@ module Rooftop
       @ssl_options = {}
       @proxy = nil
       @post_type_mapping = {}
+      @logger = nil
     end
 
     def api_path=(path)
       @api_path = path || @api_path
     end
 
-    def user_agent=(agent)
-      @user_agent = agent || @user_agent
-    end
-
     def extra_headers=(headers)
       @extra_headers = headers || @extra_headers
     end
@@ -80,7 +77,16 @@ module Rooftop
 
       @connection_path = "#{@url}#{@api_path}"
 
-      @connection.setup url: @connection_path, ssl: @ssl_options, proxy: @proxy do |c|
+      @connection.setup url: @connection_path, ssl: @ssl_options, proxy: @proxy, send_only_modified_attributes: true do |c|
+        c.use Rooftop::EmbedMiddleware
+
+        c.use Rooftop::PaginationMiddleware
+
+        if @logger
+          c.use Rooftop::DebugMiddleware
+        end
+
+
         #Headers
         c.use Rooftop::Headers
 

data/lib/rooftop/base.rb

@@ -19,16 +19,26 @@ module Rooftop
       base.include Rooftop::Queries
       # Links mixin handles the _links key in a response
       base.include Rooftop::ResourceLinks
+
+      # Pagination mixin - uses pagination metadata set in the PaginationMiddleware
+      base.include Rooftop::Pagination
+
       # Use the API instance we have configured - in a proc because we can't control load order
       base.send(:use_api,->{Rooftop.configuration.connection})
 
       # Turn calls to `content` into a collection of Rooftop::ContentField objects
       base.include Rooftop::Content
 
+      # Add some useful scopes
+      base.include Rooftop::Scopes
+
+      # Coerce the title field from an object to a string
+      base.include Rooftop::Coercions::TitleCoercion
+
       # Date and Modified fields are pretty universal in responses from WP, so we can automatically
       # coerce these to DateTime.
-      base.send(:coerce_field,date: ->(date) {DateTime.parse(date)})
-      base.send(:coerce_field,modified: ->(modified) {DateTime.parse(modified)})
+      base.send(:coerce_field,date: ->(date) {DateTime.parse(date.to_s) unless date.nil?})
+      base.send(:coerce_field,modified: ->(modified) {DateTime.parse(modified.to_s) unless modified.nil?})
 
       # Having coerced the fields, we can alias them (order is important - coerce first.)
       base.send(:alias_field, date: :created_at)
@@ -64,7 +74,6 @@ module Rooftop
       def setup_path!
         @api_endpoint ||= collection_path
         self.collection_path "#{@api_namespace}/v#{@api_version}/#{@api_endpoint}"
-
       end
 
       # Allow calling 'first'
@@ -72,10 +81,9 @@ module Rooftop
         all.first
       end
 
-
-
-
+      def reload!
+        self.class.find(self.id) if self.id
+      end
     end
-
   end
-end
+end

data/lib/rooftop/coercions.rb

@@ -15,6 +15,11 @@ module Rooftop
           end
         end
       })
+      base.send(:before_save, ->(r) {
+        r.coercions.each do |field,coercion|
+          r.send(:"restore_#{field}!") unless r.new?
+        end
+      })
     end
 
     module ClassMethods

data/lib/rooftop/coercions/title_coercion.rb

@@ -0,0 +1,26 @@
+module Rooftop
+  module Coercions
+    module TitleCoercion
+      def self.included(base)
+        base.send(:after_find, :coerce_title_to_string)
+        base.send(:after_save, :coerce_title_to_string)
+
+        base.send(:before_save, ->(record) {
+          if record.respond_to?(:title) && record.respond_to?(:title_object)
+            record.title_object ||= {}
+            record.title_object[:rendered] = record.title
+          end
+        })
+
+      end
+
+      def coerce_title_to_string
+        record = self
+        if record.respond_to?(:title) && record.title.is_a?(ActiveSupport::HashWithIndifferentAccess)
+          record.title_object = record.title
+          record.title = record.title[:rendered]
+        end
+      end
+    end
+  end
+end

data/lib/rooftop/content/collection.rb

@@ -2,9 +2,20 @@ module Rooftop
   module Content
     class Collection < ::Array
       def initialize(content_fields)
-          content_fields.each do |field|
-            self << Rooftop::Content::Field.new(field)
+        content_fields.each do |field|
+          # if the field has a 'fields' key, it is a repeater field. Collect the sub-fields and
+          # set the field content to the collection of repeated fields
+          if field.has_key?('fields')
+            repeated_fields = field[:fields].collect do |repeated_fields|
+              repeated_fields.collect{|field| Rooftop::Content::Field.new(field)}
+            end
+            
+            field.delete(:fields)
+            field[:value] = repeated_fields
           end
+
+          self << Rooftop::Content::Field.new(field)
+        end
       end
 
       # Find content_fields by attribute. Assume there will only be one attribute in the search
@@ -42,4 +53,4 @@ module Rooftop
 
     end
   end
-end
+end

data/lib/rooftop/content/content_fields.rb

@@ -34,6 +34,11 @@ module Rooftop
           r.fields = Rooftop::Content::Collection.new((basic_fields + advanced_fields))
         end
       })
+
+      base.send(:before_save, ->(r) {
+        r.restore_fields! unless r.new?
+        #TODO we need to write these back into the actual fields.
+      })
     end
   end
-end
+end

data/lib/rooftop/content/field.rb

@@ -2,11 +2,33 @@ module Rooftop
   module Content
     class Field < ::OpenStruct
 
+      #todo - this would be nice to get working. For a relationship, we should be returning the object not a big hash
+      # def initialize(hash=nil)
+      #   if hash.has_key?(:type) && hash[:type] == "relationship"
+      #     related_objects = [hash[:value]].flatten
+      #     hash[:value] = related_objects.inject([]) do |array,object|
+      #       begin
+      #         klass = Rooftop.configuration.post_type_mapping[object[:post_type].to_sym] || object[:post_type].to_s.classify.constantize
+      #         array << klass.new(object).run_callbacks(:find)
+      #       rescue
+      #         array << object
+      #       end
+      #     end
+      #     super
+      #   else
+      #     super
+      #   end
+      # end
+
+
 
       def to_s
-        value if respond_to?(:value)
+        if respond_to?(:value) && value.is_a?(String)
+          value
+        else
+          inspect
+        end
       end
-
     end
   end
 end

data/lib/rooftop/errors/unresolveable_link_error.rb

@@ -0,0 +1,5 @@
+module Rooftop
+  module ResourceLinks
+    class UnresolvableLinkError < NoMethodError; end
+  end
+end

data/lib/rooftop/field_aliases.rb

@@ -19,6 +19,12 @@ module Rooftop
         end
       })
 
+      base.send(:before_save, ->(r) {
+        r.field_aliases.each do |old,new|
+          r.send(:"restore_#{new}!") unless r.new?
+        end
+      })
+
     end
 
     module ClassMethods

data/lib/rooftop/middleware/debug_middleware.rb

@@ -0,0 +1,60 @@
+# Code courtesty https://github.com/envylabs/faraday-detailed_logger - MIT licence
+
+module Rooftop
+  class DebugMiddleware < Faraday::Response::Middleware
+
+    def self.default_logger
+      require "logger"
+      ::Logger.new(STDOUT)
+    end
+
+    # Public: Initialize a new Logger middleware.
+    #
+    # app - A Faraday-compatible middleware stack or application.
+    # logger - A Logger-compatible object to which the log information will
+    #          be recorded.
+    # progname - A String containing a program name to use when logging.
+    #
+    # Returns a Logger instance.
+    #
+    def initialize(app, logger = nil, progname = nil)
+      super(app)
+      @logger = logger || self.class.default_logger
+      @progname = progname
+    end
+
+
+    def call(env)
+      if Rooftop.debug_requests
+        @logger.info(@progname) { "#{env[:method].upcase} #{env[:url]}" }
+        @logger.debug(@progname) { curl_output(env[:request_headers], env[:body]).inspect }
+      end
+      super
+    end
+
+    def on_complete(env)
+      if Rooftop.debug_responses
+        status = env[:status]
+        log_response_status(@progname, status) { "HTTP #{status}" }
+        @logger.debug(@progname) { curl_output(env[:response_headers], env[:body]).inspect }
+      end
+    end
+
+    private
+    def curl_output(headers, body)
+      string = headers.collect { |k,v| "#{k}: #{v}" }.join("\n")
+      string + "\n\n#{body}"
+    end
+
+    def log_response_status(progname, status, &block)
+      case status
+        when 200..399
+          @logger.info(progname, &block)
+        else
+          @logger.warn(progname, &block)
+      end
+    end
+
+  end
+
+end

data/lib/rooftop/middleware/embed_middleware.rb

@@ -0,0 +1,18 @@
+# This is a bit hacky. It looks like Her.rb strips querystrings with an underscore, and WP requires
+# '?_embed' in order to embed child links. We look for a query param called 'embed' and change it
+# to _embed (as well as sending the original)
+
+module Rooftop
+  class EmbedMiddleware < Faraday::Middleware
+
+    def call(env)
+      query = Faraday::Utils.parse_query(env.url.query) || {}
+      query["_embed"] = true if query.has_key?("include_embedded_resources")
+      query["per_page"] = 99999999 unless query.has_key?("per_page")
+      env.url.query = Faraday::Utils.build_query(query.except("include_embedded_resources"))
+      @app.call env
+    end
+
+  end
+
+end

data/lib/rooftop/{headers.rb → middleware/headers.rb}

@@ -5,6 +5,10 @@ module Rooftop
         env[:request_headers]["Api-Token"] = Rooftop.configuration.api_token
       end
 
+      if Rooftop.preview
+        env[:request_headers]['preview'] = "true"
+      end
+
       Rooftop.configuration.extra_headers.each do |key,value|
         env[:request_headers][key.to_s] = value
       end

data/lib/rooftop/middleware/pagination_middleware.rb

@@ -0,0 +1,26 @@
+module Rooftop
+  class PaginationMiddleware < Faraday::Response::Middleware
+    def on_complete(env)
+      @env = env
+
+      pagination = {
+          total_count: header("x-wp-total").to_i,
+          total_pages: header("x-wp-totalpages").to_i,
+          per_page:    (header("x-wp-per-page").to_i || 10),
+          page:        header("x-wp-page").to_i || 1
+      }
+
+      env[:body].merge!(pagination: pagination)
+    end
+
+    private
+
+    # Returns a response header value.
+    #
+    # @param [String] name of the header attribute
+    # @return [String] the response header value
+    def header(name)
+      @env.response_headers[name]
+    end
+  end
+end

data/lib/rooftop/nested.rb

@@ -1,5 +1,18 @@
 module Rooftop
   module Nested
+    
+    def self.included(base)
+      @nested_classes ||= []
+      @nested_classes << base unless @nested_classes.include?(base)
+    end
+
+    def self.nested_classes
+      @nested_classes
+    end
+
+    def root
+      ancestors.last || resource_links.find_by(link_type: 'self').first
+    end
 
     def ancestors
       if respond_to?(:resource_links)
@@ -18,9 +31,13 @@ module Rooftop
     end
 
     def parent
-      if respond_to?(:resource_links)
-        resource_links.find_by(link_type: "up").first
+      if respond_to?(:resource_links) && resource_links
+        ancestors.first
       end
     end
+
+    def siblings
+      self.class.find(parent.id).children.reject! {|c| c.id == self.id}
+    end
   end
 end

data/lib/rooftop/page.rb

@@ -1,11 +1,17 @@
 module Rooftop
   module Page
     def self.included(base)
+      @page_classes ||= []
+      @page_classes << base unless @page_classes.include?(base)
       base.include Rooftop::Base
       base.include Rooftop::Nested
       base.extend ClassMethods
     end
 
+    def self.page_classes
+      @page_classes
+    end
+
     module ClassMethods
 
 

data/lib/rooftop/pagination.rb

@@ -0,0 +1,16 @@
+module Rooftop
+  module Pagination
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def new_collection(parsed_data)
+        parsed_data[:metadata] ||= {}
+        parsed_data[:metadata][:pagination] = parsed_data[:pagination]
+
+        Her::Model::Attributes.initialize_collection(self, parsed_data)
+      end
+    end
+  end
+end

data/lib/rooftop/queries/queries.rb

@@ -1,12 +1,13 @@
 module Rooftop
   module Queries
+    PER_PAGE = 99999999
     def self.included(base)
       base.extend ClassMethods
     end
 
     module ClassMethods
       # We need to fix up the `where()` filter. WP-API expects a url format for filters like this:
-      # /?filter[something]=foo.
+      # /?filter[something]=foo. But we have a magic hash key to allow us to send things which aren't mangled.
       def where(args)
         args = HashWithIndifferentAccess.new(args)
         # the fact that 'slug' is referred to in the db as 'name' is irritating. Let's fix that
@@ -34,7 +35,27 @@ module Rooftop
           end
           args.delete(:id)
         end
-        filters =  args.inject({}) {|hash,pair| hash["filter[#{pair.first}]"] = pair.last; hash}
+
+        if args.keys.include?('per_page')
+          per_page = args['per_page']
+          args[:no_filter] ||= []
+          args[:no_filter] << :per_page unless args[:no_filter].include?('per_page')
+        else
+          per_page = Rooftop::Queries::PER_PAGE
+        end
+
+        if args.keys.collect(&:to_sym).include?(:no_filter)
+          args_to_filter = args.except(*args[:no_filter]).except(:no_filter)
+          args_not_to_filter = args.except(args_to_filter).except(:no_filter)
+          filters =  args_to_filter.inject({}) {|hash,pair| hash["filter[#{pair.first}]"] = pair.last; hash}
+          filters = {per_page: per_page}.merge(filters).merge(args_not_to_filter)
+        else
+          #TODO DRY
+          filters =  args.inject({}) {|hash,pair| hash["filter[#{pair.first}]"] = pair.last; hash}
+          filters = {per_page: per_page}.merge(filters)
+        end
+
+        # we probably want every result without pagination, unless we specify otherwise
         #Call the Her `where` method with our new filters
         super().where(filters)
       end
@@ -49,6 +70,11 @@ module Rooftop
           raise Rooftop::RecordNotFoundError
         end
       end
+
+      # 'all' needs to have a querystring param passed to really get all. It should be -1 but for some reason that's not working.
+      def all(args = {})
+        super({per_page: Rooftop::Queries::PER_PAGE}.merge(args))
+      end
     end
   end
-end
+end

data/lib/rooftop/resource_links/collection.rb

@@ -2,10 +2,10 @@ module Rooftop
   module ResourceLinks
     class Collection < ::Array
       attr_reader :links
-      def initialize(links)
+      def initialize(links, klass=nil)
         links.each do |link_type,links|
           links.each do |link|
-            self << Rooftop::ResourceLinks::Link.new(link_type,link)
+            self << Rooftop::ResourceLinks::Link.new(link_type,link, klass)
           end
         end
       end

data/lib/rooftop/resource_links/link.rb

@@ -2,13 +2,29 @@ module Rooftop
   module ResourceLinks
     class Link < ::OpenStruct
       attr_accessor :link_type
-      def initialize(link_type,args)
+      def initialize(link_type,args, klass=nil)
         @link_type = link_type
+        @mapped_class = klass.try(:resource_link_mapping).try(:[],@link_type)
         super(args)
       end
 
-      def resolve
-        raise NotImplementedError, "TODO: resolve the link."
+      def resolve(klass=nil)
+        # We need to figure out what we're going to instantiate. If it's in the resource link mapping, use that. If not, try the klass passed into the resolve() method. Failing that, make an attempt to constantize something; otherwise we're going to have to raise
+        @mapped_class ||= klass || @link_type.camelize.classify.constantize
+        if @mapped_class
+          # If this link has an ID, we can call find() on the class
+          if respond_to?(:id)
+            return @mapped_class.send(:find, id)
+          else
+            # otherwise we're going to have make a call to the link's href.
+            result = @mapped_class.get(href)
+            result.run_callbacks(:find)
+            return result
+          end
+        else
+          raise Rooftop::ResourceLinks::UnresolvableLinkError, "Couldn't resolve a link of type #{@link_type}. Try passing the class you want to resolve to."
+        end
+
       end
     end
   end

data/lib/rooftop/resource_links/resource_links.rb

@@ -1,15 +1,41 @@
 module Rooftop
   module ResourceLinks
     CUSTOM_LINK_RELATION_BASE = "http://docs.rooftopcms.com/link_relations"
+
     def self.included(base)
       # set up an attribute called resource_links, which is a collection of links
       # to other resources in the API.
-      base.send(:after_find, ->(r) {
-        if r.respond_to?(:"_links")
-          r.resource_links = Rooftop::ResourceLinks::Collection.new(r._links)
-        end
-      })
+      base.send(:after_find, :generate_resource_links)
+      base.send(:after_save, :generate_resource_links)
+      base.extend ClassMethods
+      base.configure_resource_link_mapping
+    end
+
+    def generate_resource_links
+      if self.respond_to?(:"_links")
+        self.resource_links = Rooftop::ResourceLinks::Collection.new(self._links, self.class)
+      end
     end
 
+    module ClassMethods
+      # This class-level attribute allows us to set a mapping between a resource link name (which is probably
+      # an href, but might be "up" or something) and a class. It means that when we try to resolve a link of a
+      # given name, we know what type of class to instantiate
+      attr_accessor :resource_link_mapping
+
+      def configure_resource_link_mapping
+        @resource_link_mapping ||= {}
+        @resource_link_mapping.merge!({
+                                      "author" => Rooftop::Author,
+                                      "https://api.w.org/attachment" => Rooftop::MediaItem,
+                                      "self" => self,
+                                      "up" => self,
+                                      "http://docs.rooftopcms.com/link_relations/ancestors" => self,
+                                      "http://docs.rooftopcms.com/link_relations/children" => self
+                                    })
+      end
+    end
+
+
   end
 end

data/lib/rooftop/scopes.rb

@@ -0,0 +1,9 @@
+module Rooftop
+  module Scopes
+    def self.included(base)
+      base.send(:scope, :with_embedded_resources, -> {where(include_embedded_resources: true)})
+    end
+
+
+  end
+end

data/lib/rooftop/version.rb

@@ -1,3 +1,3 @@
 module Rooftop
-  VERSION = "0.0.6"
+  VERSION = "0.0.7.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rooftop
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7.4
 platform: ruby
 authors:
 - Ed Jones
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-27 00:00:00.000000000 Z
+date: 2016-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,28 +112,35 @@ files:
 - lib/rooftop/coercions.rb
 - lib/rooftop/coercions/author_coercion.rb
 - lib/rooftop/coercions/parent_coercion.rb
+- lib/rooftop/coercions/title_coercion.rb
 - lib/rooftop/content/collection.rb
 - lib/rooftop/content/content_fields.rb
 - lib/rooftop/content/field.rb
 - lib/rooftop/errors/field_not_found_error.rb
 - lib/rooftop/errors/record_not_found_error.rb
 - lib/rooftop/errors/unmapped_object_error.rb
+- lib/rooftop/errors/unresolveable_link_error.rb
 - lib/rooftop/field_aliases.rb
-- lib/rooftop/headers.rb
 - lib/rooftop/hook_calls.rb
 - lib/rooftop/menus/item.rb
 - lib/rooftop/menus/menu.rb
+- lib/rooftop/middleware/debug_middleware.rb
+- lib/rooftop/middleware/embed_middleware.rb
+- lib/rooftop/middleware/headers.rb
+- lib/rooftop/middleware/pagination_middleware.rb
 - lib/rooftop/models/author.rb
 - lib/rooftop/models/media_item.rb
 - lib/rooftop/models/taxonomy.rb
 - lib/rooftop/models/taxonomy_term.rb
 - lib/rooftop/nested.rb
 - lib/rooftop/page.rb
+- lib/rooftop/pagination.rb
 - lib/rooftop/post.rb
 - lib/rooftop/queries/queries.rb
 - lib/rooftop/resource_links/collection.rb
 - lib/rooftop/resource_links/link.rb
 - lib/rooftop/resource_links/resource_links.rb
+- lib/rooftop/scopes.rb
 - lib/rooftop/version.rb
 - rooftop.gemspec
 homepage: http://www.rooftopcms.com