ghost_rb 0.2.0

data/docs/index.md

@@ -0,0 +1,3 @@
+---
+layout: default
+---

data/ghost_rb.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ghost_rb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ghost_rb"
+  spec.version       = GhostRb::VERSION
+  spec.authors       = ["Rene Hernandez"]
+  spec.email         = ["renehr9102@gmail.com"]
+
+  spec.summary       = %q{GhostRb is a REST API client to interact with a given Ghost blog}
+  spec.homepage      = "https://github.com/renehernandez/ghost_rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|doc)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httpclient", "~> 2.8"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard", "~> 0.9"
+  spec.add_development_dependency "rubocop", "~> 0.49"
+  spec.add_development_dependency "simplecov", "~> 0.15"
+end

data/lib/ghost_rb.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'ghost_rb/version'
+require 'ghost_rb/client'
+require 'ghost_rb/errors'
+require 'ghost_rb/resources/hydratable'
+require 'ghost_rb/resources/base_resource'
+require 'ghost_rb/resources/post'
+require 'ghost_rb/resources/user'
+require 'ghost_rb/resources/tag'
+require 'ghost_rb/controllers/base_controller'
+require 'ghost_rb/controllers/posts_controller'
+require 'ghost_rb/controllers/tags_controller'
+
+# @author Rene Hernandez
+# @since 0.1
+module GhostRb
+  # Your code goes here...
+end

data/lib/ghost_rb/client.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'httpclient'
+require 'uri'
+require 'json'
+
+module GhostRb
+  # @author Rene Hernandez
+  # @since 0.1
+  class Client
+    attr_reader :base_url, :client_id, :client_secret, :default_query
+
+    REQUEST_OK = 200
+
+    def initialize(base_url, client_id, client_secret)
+      @base_url = URI.join(base_url, 'ghost/', 'api/', 'v0.1/')
+      @client_id = client_id
+      @client_secret = client_secret
+      @http = HTTPClient.new(base_url: @base_url)
+      @default_query = { client_id: @client_id, client_secret: @client_secret }
+    end
+
+    def posts
+      Controllers::PostsController.new(self)
+    end
+
+    def tags
+      Controllers::TagsController.new(self)
+    end
+
+    def get(endpoint, query)
+      response = @http.get(endpoint, query, {}, follow_redirect: true)
+      content = JSON.parse(response.body)
+      [response.status_code, content]
+    end
+  end
+end

data/lib/ghost_rb/controllers/base_controller.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module GhostRb
+  # @author Rene Hernandez
+  # @since 0.2
+  module Controllers
+    # @author Rene Hernandez
+    # @since 0.2
+    class BaseController
+      attr_reader :client, :params
+
+      def initialize(client)
+        @client = client
+        @params = {}
+      end
+
+      def limit(limit)
+        where(limit: limit)
+      end
+
+      def page(page)
+        where(page: page)
+      end
+
+      def order(order_str)
+        where(order: order_str)
+      end
+
+      def fields(fields_str)
+        where(fields: fields_str)
+      end
+
+      def filter(filter_query)
+        where(filter: filter_query)
+      end
+
+      def include(resources_str)
+        where(include: resources_str)
+      end
+
+      def where(hash)
+        @params.merge!(hash)
+        self
+      end
+
+      def find_by(kvp)
+        @params.keys.reject { |k| k == :include }.each do |key|
+          @params.delete(key)
+        end
+
+        fetch_single(kvp)
+      end
+
+      private
+
+      def fetch_single(kvp)
+        endpoint = format_endpoint(kvp)
+        query = client.default_query.merge(@params)
+        status, content = client.get(endpoint, query)
+
+        if error?(status)
+          raise_fetch_single_error(kvp, status, content['errors'])
+        end
+
+        resource_klass.generate(content)
+      end
+
+      def fetch_list
+        query = client.default_query.merge(@params)
+        status, content = client.get(endpoint, query)
+
+        raise_fetch_list_error(status, content['errors']) if error?(status)
+
+        content
+      end
+
+      def error?(status)
+        status >= 400
+      end
+
+      def format_endpoint(kvp)
+        return [endpoint, kvp[:id]].join('/') if kvp.key?(:id)
+        return [endpoint, 'slug', kvp[:slug]].join('/') if kvp.key?(:slug)
+
+        raise Errors::InvalidEndpointError,
+              "Invalid endpoint for #{endpoint}. Should be either :id or :slug"
+      end
+    end
+  end
+end

data/lib/ghost_rb/controllers/posts_controller.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module GhostRb
+  module Controllers
+    # @author Rene Hernandez
+    # @since 0.2
+    class PostsController < BaseController
+      attr_reader :endpoint, :resource_klass
+
+      def initialize(client)
+        super
+        @endpoint = 'posts'
+        @resource_klass = Resources::Post
+      end
+
+      def all
+        fetch_list['posts'].map { |r| @resource_klass.generate(r) }
+      end
+
+      def formats(formats)
+        where(formats: formats)
+      end
+
+      private
+
+      def raise_fetch_single_error(kvp, status, errors)
+        key = kvp.key?(:id) ? :id : :slug
+        message = "Unable to fetch tag with #{key} = #{kvp[key]}"
+        raise Errors::RequestError.new(message,
+                                       status,
+                                       errors)
+      end
+
+      def raise_fetch_list_error(status, errors)
+        raise Errors::RequestError.new('Unable to fetch posts',
+                                       status,
+                                       errors)
+      end
+    end
+  end
+end

data/lib/ghost_rb/controllers/tags_controller.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module GhostRb
+  module Controllers
+    # @author Rene Hernandez
+    # @since 0.2
+    class TagsController < BaseController
+      attr_reader :endpoint, :resource_klass
+
+      def initialize(client)
+        super
+        @endpoint = 'tags'
+        @resource_klass = Resources::Tag
+      end
+
+      def all
+        fetch_list['tags'].map { |r| @resource_klass.generate(r) }
+      end
+
+      private
+
+      def raise_fetch_single_error(kvp, status, errors)
+        key = kvp.key?(:id) ? :id : :slug
+        message = "Unable to fetch tag with #{key} = #{kvp[key]}"
+        raise Errors::RequestError.new(message,
+                                       status,
+                                       errors)
+      end
+
+      def raise_fetch_list_error(status, errors)
+        raise Errors::RequestError.new('Unable to fetch tags',
+                                       status,
+                                       errors)
+      end
+    end
+  end
+end

data/lib/ghost_rb/errors.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module GhostRb
+  # @author Rene Hernandez
+  # @since 0.2
+  module Errors
+    # @author Rene Hernandez
+    # @since 0.2
+    class RequestError < StandardError
+      attr_reader :status, :errors
+
+      def initialize(message, status, errors)
+        super(message)
+        @status = status
+        @errors = errors
+      end
+    end
+
+    # @author Rene Hernandez
+    # @since 0.2
+    InvalidEndpointError = Class.new(StandardError)
+  end
+end

data/lib/ghost_rb/resources/base_resource.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module GhostRb
+  # @author Rene Hernandez
+  # @since 0.1
+  module Resources
+    # @author Rene Hernandez
+    # @since 0.1
+    class BaseResource
+      include Hydratable
+
+      def self.generate(hash)
+        res_instance = new
+        res_instance.hydrate(hash)
+        res_instance
+      end
+    end
+  end
+end

data/lib/ghost_rb/resources/hydratable.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module GhostRb
+  module Resources
+    # @author Rene Hernandez
+    # @since 0.1
+    module Hydratable
+      def hydrate(hash)
+        hash.each do |k, v|
+          method_symbol = "#{k}=".to_sym
+          public_send(method_symbol, v) if respond_to?(method_symbol)
+        end
+      end
+    end
+  end
+end

data/lib/ghost_rb/resources/post.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module GhostRb
+  module Resources
+    # @author Rene Hernandez
+    # @since 0.1
+    class Post < BaseResource
+      attr_accessor :id, :title, :slug, :html, :page,
+                    :status, :published_at, :created_at, :author_id,
+                    :visibility, :featured, :plaintext, :author, :tags
+
+      alias page? page
+
+      alias featured? featured
+
+      def self.generate(hash)
+        inst = super(hash)
+        inst.author = User.generate(hash[:author]) if hash.key?(:author)
+        inst.tags = hash[:tags].map { |t| Tag.generate(t) } if hash.key?(:tags)
+
+        inst
+      end
+    end
+  end
+end

data/lib/ghost_rb/resources/tag.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module GhostRb
+  module Resources
+    # @author Rene Hernandez
+    # @since 0.1
+    class Tag < BaseResource
+      attr_accessor :id, :name, :slug, :visibility, :posts_count
+
+      def self.generate(hash)
+        inst = super(hash)
+        inst.posts_count = hash[:count][:posts].to_i if hash.key?(:count)
+
+        inst
+      end
+    end
+  end
+end

data/lib/ghost_rb/resources/user.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module GhostRb
+  module Resources
+    # @author Rene Hernandez
+    # @since 0.1
+    class User < BaseResource
+      attr_accessor :id, :bio, :location, :name, :slug,
+                    :visibility, :website, :posts_count
+
+      def self.generate(hash)
+        inst = super(hash)
+        inst.posts_count = hash[:count][:posts].to_i if hash.key?(:count)
+
+        inst
+      end
+    end
+  end
+end

data/lib/ghost_rb/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GhostRb
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: ghost_rb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Rene Hernandez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: 
+email:
+- renehr9102@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/httpclient
+- bin/setup
+- docs/404.html
+- docs/Gemfile
+- docs/Gemfile.lock
+- docs/_config.yml
+- docs/_includes/head.html
+- docs/_includes/page-footer.html
+- docs/_includes/page-header.html
+- docs/_layouts/default.html
+- docs/_layouts/page.html
+- docs/css/cayman.css
+- docs/css/normalize.css
+- docs/index.md
+- ghost_rb.gemspec
+- lib/ghost_rb.rb
+- lib/ghost_rb/client.rb
+- lib/ghost_rb/controllers/base_controller.rb
+- lib/ghost_rb/controllers/posts_controller.rb
+- lib/ghost_rb/controllers/tags_controller.rb
+- lib/ghost_rb/errors.rb
+- lib/ghost_rb/resources/base_resource.rb
+- lib/ghost_rb/resources/hydratable.rb
+- lib/ghost_rb/resources/post.rb
+- lib/ghost_rb/resources/tag.rb
+- lib/ghost_rb/resources/user.rb
+- lib/ghost_rb/version.rb
+homepage: https://github.com/renehernandez/ghost_rb
+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.6.13
+signing_key: 
+specification_version: 4
+summary: GhostRb is a REST API client to interact with a given Ghost blog
+test_files: []