rooftop 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0267eebc56ea252a961d42eab13531197d5b877b
+  data.tar.gz: a66492c5b3a875fa05319456ad8cc75aa229de80
+SHA512:
+  metadata.gz: 42a735d1e99e4289de01a2561f63624aeb05eeb73c9cd6c203eda2789dd20098502f9b20e445163ff9f5db76f3cd1270553dfd23b327d25e6a8bd874b20dadc5
+  data.tar.gz: 00eee33e7a992852c9a70fcc356b4eeef69c438ca1480d3605c817960500f635d69bfa895882c052c6634088e46cdd1e7be7cc80d25e218488c17ef59bddc2db

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rooftop_ruby_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ed Jones
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# Rooftop
+A mixin for Ruby classes to access the Wordpress REST API (http://wp-api.org)
+
+# Setup
+
+## Configuration
+You need to configure Rooftop with a block, like this
+
+```
+    Rooftop.configure do |config|
+        config.url = "http://your.rooftop-cms.site/wp-json"
+    end
+```
+
+# Use
+Create a class and use one of the mixins to get the data.
+
+## Rooftop::Post
+The Rooftop::Post mixin lets you specify a post type, so the API differentiates between types.
+
+```
+class MyCustomPostType
+    include Rooftop::Post
+    self.post_type = "my_custom_post_type" #this is the post type name in Wordpress
+end
+```
+## Rooftop::Page
+The Rooftop::Page mixin identifies this class as a page.
+```
+class Page
+    include Rooftop::Page
+end
+```
+
+## Field coercions
+Sometimes you want to do something with a field after it's returned. For example, it would be useful to parse date strings to DateTime.
+
+To coerce one or more fields, call a class method in your class and pass a lambda which is called on the field.
+
+```
+class MyCustomPostType
+    include Rooftop::Post
+    self.post_type = "my_custom_post_type"
+    coerce_field date: ->(date) { DateTime.parse(date)}
+```
+
+There are some coercions done manually.
+
+### Author
+When an object is returned from the API, the Author information is automatically parsed into a Rooftop::Author object.
+
+### Date
+Created date is coerced to a DateTime. It's also aliased to created_at
+
+### Modified
+The modification date is coerced to a DateTime. It's also aliased to updated_at
+
+# To do
+Lots! Here's a flavour:
+
+* Taxonomies need to be supported (http://wp-api.org/#taxonomies_retrieve-all-taxonomies)
+* Authentication: there are a couple of ways of doing this, but the simplest would be a quick WP plugin to generate a per-user API key which we pass in the header.
+* Preview: once authentication is solved, we need to be able to show posts in draft
+* Media: media is exposed by the API. Don't know if this explicitly needs supporting by the API or just accessible
+* Allowing other classes to be exposed: mixing in Rooftop::Client *should* allow a custom class to hit the right endpoint, but it's work-in-progress
+
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rooftop.rb

@@ -0,0 +1,59 @@
+require 'her'
+require 'require_all'
+require_rel '.'
+
+require "active_support/all"
+
+module Rooftop
+  class << self
+    #accessor to set the preview API for use instead of the production one
+    attr_accessor :use_preview_api
+
+    #access the configuration class as Rooftop.configuration
+    attr_accessor :configuration
+
+    #block for configuration.
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+      self.configuration.configure_connection
+    end
+
+  end
+
+  class Configuration
+    attr_accessor :api_token, :url, :extra_headers
+    attr_reader :connection
+
+    def initialize
+      @extra_headers ||= []
+      @connection ||= Her::API.new
+    end
+
+    # Return the Configuration object as a hash, with symbols as keys.
+    # @return [Hash]
+    def to_hash
+      Hash[instance_variables.map { |name| [name.to_s.gsub("@","").to_sym, instance_variable_get(name)] } ]
+    end
+
+    def configure_connection
+      if @url.nil?
+        raise ArgumentError, "You need to configure Rooftop before instantiating a class with a Rooftop mixin"
+      end
+
+      @connection.setup url: @url do |c|
+        #Headers
+        c.use Rooftop::Headers
+
+        # Request
+        c.use Faraday::Request::UrlEncoded
+
+        # Response
+        c.use Her::Middleware::DefaultParseJSON
+
+        # Adapter
+        c.use Faraday::Adapter::NetHttp
+      end
+    end
+  end
+end

data/lib/rooftop_client/base.rb

@@ -0,0 +1,38 @@
+module Rooftop
+  module Base
+    def self.included(base)
+      base.include Her::Model
+      # Coercions allow you to pass a block to do something with a returned field
+      base.include Rooftop::Coercions
+      # Queries mixin includes a fixup for there `where()` method
+      base.include Rooftop::Queries
+      # Use the API instance we have configured - in a proc because we can't control load order
+      base.send(:use_api,->{Rooftop.configuration.connection})
+      # WP returns an uppercase attribute for ID. Annoying.
+      # base.send(:primary_key, :"ID")
+      # 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.extend ClassMethods
+    end
+
+    module ClassMethods
+      # Allow calling 'first'
+      def first
+        all.first
+      end
+    end
+
+    # Utility method to make the 'created' field have a more rubyish name
+    def created_at
+      date
+    end
+
+    # Utility method to make the 'updated' field have a more rubyish name
+    def updated_at
+      modified
+    end
+
+  end
+end

data/lib/rooftop_client/client.rb

@@ -0,0 +1,24 @@
+module Rooftop
+  module Client
+    def self.included(base)
+      if Rooftop.configuration.url.nil?
+        raise ArgumentError, "You need to configure Rooftop before instantiating a class with a Rooftop mixin"
+      end
+
+      Her::API.setup url: Rooftop.configuration.url do |c|
+        #Headers
+        c.use Rooftop::Headers
+
+        # Request
+        c.use Faraday::Request::UrlEncoded
+
+        # Response
+        c.use Her::Middleware::DefaultParseJSON
+
+        # Adapter
+        c.use Faraday::Adapter::NetHttp
+      end
+      base.include Her::Model
+    end
+  end
+end

data/lib/rooftop_client/coercions/author_coercion.rb

@@ -0,0 +1,8 @@
+module Rooftop
+  module AuthorCoercion
+    def self.included(base)
+      base.send(:after_find, ->(r) { r.author.registered = DateTime.parse(r.author.registered)})
+      base.send(:coerce_field, {author: ->(author) { Rooftop::Author.new(author) }})
+    end
+  end
+end

data/lib/rooftop_client/coercions/parent_coercion.rb

@@ -0,0 +1,45 @@
+# Coerce any field called 'parent' which returns an ID into an actual object
+module Rooftop
+  module ParentCoercion
+    def self.included(base)
+      base.extend ClassMethods
+      # base.send(:after_find, ->(r) {
+      #   if r.has_parent?
+      #     r.instance_variable_set(:"parent_#{base.to_s.underscore}", resolve_parent_id())
+      #     r.class.send(:attr_reader, :"parent_#{base.to_s.underscore}")
+      #   end
+      # })
+      # base.send(:coerce_field, parent: ->(p) { base.send(:resolve_parent_id,p) })
+    end
+
+    module ClassMethods
+      def add_parent_reference
+        define_method :"parent_#{self.to_s.underscore}" do
+          puts "hello"
+        end
+      end
+    end
+
+    def has_parent?
+      respond_to?(:parent) && parent.is_a?(Fixnum) && parent != 0
+    end
+
+    def resolve_parent_id
+      if respond_to?(:parent)
+        if parent.is_a?(Fixnum)
+          if parent == 0
+            #no parent
+            return nil
+          else
+            return self.class.send(:find, id)
+          end
+        else
+          return parent
+        end
+
+      end
+
+    end
+  end
+
+end

data/lib/rooftop_client/coercions.rb

@@ -0,0 +1,32 @@
+module Rooftop
+  module Coercions
+    def self.included(base)
+      base.extend ClassMethods
+      # `after_find` is a method provided by Her; we iterate over our coercions and call each lambda
+      base.send(:after_find, ->(r){
+        r.coercions.each do |field,coercion|
+          if r.respond_to?(field)
+            r.send("#{field}=",coercion.call(r.send(field)))
+          end
+        end
+      })
+    end
+
+    module ClassMethods
+      # Call coerce_field() in a class to do something with the attribute. Useful for parsing dates etc.
+      # @param coercion [Hash] the coercion to apply - key is the field, value is a lambda
+      def coerce_field(*coercions)
+        @coercions ||= {}
+        coercions.each do |coercions_hash|
+          @coercions.merge!(coercions_hash)
+        end
+        @coercions
+      end
+    end
+
+    # Instance method to get the class's coercions
+    def coercions
+      self.class.instance_variable_get(:"@coercions")
+    end
+  end
+end

data/lib/rooftop_client/headers.rb

@@ -0,0 +1,15 @@
+module Rooftop
+  class Headers < Faraday::Middleware
+    def call(env)
+      unless Rooftop.configuration.api_token.nil?
+        env[:request_headers]["API-TOKEN"] = Rooftop.configuration.api_token
+      end
+
+      Rooftop.configuration.extra_headers.each do |key,value|
+        env[:request_headers][key.to_s] = value
+      end
+      env[:request_headers]["User-Agent"] = Rooftop.configuration.user_agent
+      @app.call(env)
+    end
+  end
+end

data/lib/rooftop_client/models/author.rb

@@ -0,0 +1,18 @@
+module Rooftop
+  class Author
+    def initialize(args)
+      args.each do |k,v|
+        instance_variable_set("@#{k}", v)
+        self.class.send(:attr_accessor, k)
+      end
+    end
+
+    def id
+      self.instance_variable_get(:"@ID")
+    end
+
+    def ==(other)
+      other.respond_to?(:id) && other.id == id
+    end
+  end
+end

data/lib/rooftop_client/models/media_item.rb

@@ -0,0 +1,6 @@
+module Rooftop
+  class MediaItem
+    include Rooftop::Base
+    collection_path "media"
+  end
+end

data/lib/rooftop_client/models/menu.rb

@@ -0,0 +1,8 @@
+module Rooftop
+  class Menu
+    include Rooftop::Base
+    has_many :menu_items, class: "Rooftop::MenuItem"
+    collection_path "menus"
+    coerce_field items: ->(items) { items.collect {|i| MenuItem.new(i)} unless items.nil?}
+  end
+end

data/lib/rooftop_client/models/menu_item.rb

@@ -0,0 +1,18 @@
+module Rooftop
+  class MenuItem
+    def initialize(args)
+      args.each do |k,v|
+        instance_variable_set("@#{k}", v)
+        self.class.send(:attr_accessor, k)
+      end
+    end
+
+    def id
+      self.instance_variable_get(:"@ID")
+    end
+
+    def ==(other)
+      other.class == self.class && other.respond_to?(:id) && other.id == id
+    end
+  end
+end

data/lib/rooftop_client/models/taxonomy.rb

@@ -0,0 +1,8 @@
+module Rooftop
+  class Taxonomy
+    include Rooftop::Base
+    collection_path "taxonomies"
+    primary_key "slug"
+    has_many :terms, class_name: "Rooftop::TaxonomyTerm"
+  end
+end

data/lib/rooftop_client/models/taxonomy_term.rb

@@ -0,0 +1,6 @@
+module Rooftop
+  class TaxonomyTerm
+    include Rooftop::Base
+    primary_key "ID"
+  end
+end

data/lib/rooftop_client/page.rb

@@ -0,0 +1,19 @@
+module Rooftop
+  module Page
+    def self.included(base)
+      base.include Rooftop::Base
+      #TODO instead of the silly coercion, we should be able to use Her to do this
+      # has_one :parent, data_field: :parent, class_name: "Page", path: "/pages"
+      base.include Rooftop::ParentCoercion
+      base.extend ClassMethods
+      base.send(:collection_path,"pages")
+    end
+
+    module ClassMethods
+
+    end
+
+
+
+  end
+end

data/lib/rooftop_client/post.rb

@@ -0,0 +1,15 @@
+module Rooftop
+  module Post
+    def self.included(base)
+      base.include Rooftop::Base
+      base.extend ClassMethods
+      base.send(:collection_path,"posts")
+    end
+
+    module ClassMethods
+      def post_type=(type)
+        self.send(:default_scope, ->{ where(type: type) })
+      end
+    end
+  end
+end

data/lib/rooftop_client/queries/queries.rb

@@ -0,0 +1,24 @@
+module Rooftop
+  module Queries
+    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.
+      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
+        # in queries so we can specify {slug: "foo"}
+        if args.keys.collect(&:to_sym).include?(:slug)
+          args[:name] = args[:slug]
+          args.delete(:slug)
+        end
+        filters =  args.inject({}) {|hash,pair| hash["filter[#{pair.first}]"] = pair.last; hash}
+        #Call the Her `where` method with our new filters
+        super().where(filters)
+      end
+    end
+  end
+end

data/lib/rooftop_client/version.rb

@@ -0,0 +1,3 @@
+module Rooftop
+  VERSION = "0.0.1"
+end

data/rooftop_ruby_client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rooftop_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rooftop"
+  spec.version       = Rooftop::VERSION
+  spec.authors       = ["Ed Jones"]
+  spec.email         = ["ed@errorstudio.co.uk"]
+  spec.summary       = "An ActiveRecord-like interface to the Rooftop CMS JSON API"
+  spec.description   = "An ActiveRecord-like interface to the Rooftop CMS JSON API"
+  spec.homepage      = "http://www.rooftopcms.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "require_all"
+  spec.add_dependency "her"
+
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: rooftop
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ed Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: her
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An ActiveRecord-like interface to the Rooftop CMS JSON API
+email:
+- ed@errorstudio.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rooftop.rb
+- lib/rooftop_client/base.rb
+- lib/rooftop_client/client.rb
+- lib/rooftop_client/coercions.rb
+- lib/rooftop_client/coercions/author_coercion.rb
+- lib/rooftop_client/coercions/parent_coercion.rb
+- lib/rooftop_client/headers.rb
+- lib/rooftop_client/models/author.rb
+- lib/rooftop_client/models/media_item.rb
+- lib/rooftop_client/models/menu.rb
+- lib/rooftop_client/models/menu_item.rb
+- lib/rooftop_client/models/taxonomy.rb
+- lib/rooftop_client/models/taxonomy_term.rb
+- lib/rooftop_client/page.rb
+- lib/rooftop_client/post.rb
+- lib/rooftop_client/queries/queries.rb
+- lib/rooftop_client/version.rb
+- rooftop_ruby_client.gemspec
+homepage: http://www.rooftopcms.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: An ActiveRecord-like interface to the Rooftop CMS JSON API
+test_files: []