ghost_rb 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2950b93ddb836d175974d4c592411f479fffd479
-  data.tar.gz: 5f770516776da3f381c15649bd749c62b7e6549b
+SHA256:
+  metadata.gz: ae7d0ffa5e71dc5aa33aaacfafc9067c4e6b8bcaf9c4f21767f04236dbf98bfb
+  data.tar.gz: d754a62a53e84d262eabb9afbb07ef07f604d149a31c69caa1926f1f462f8d5c
 SHA512:
-  metadata.gz: 95d4b0c061dd1de4630de52d099fed5787a43b9b974515474966f44ee5fb6162723f24f6d5e9a112b37f855b2c7f2dbecc9d2d3bc187e0aa9f30081aa2d00b09
-  data.tar.gz: 4f674f52a9eb2584c0030fc3949fa2e63ce396e6753d21a96b5d9042d51183fc043da6ab163db56ec8ee838c848948b565b73be698ededade7a503887844aed2
+  metadata.gz: 9f9582960b53730e4642d931a98e36a67b7644a628d7fd09d6b9753607ae80662426bce46d872e3ed841b6d02131f8aa87864451a5f7233519fc0e59b7c7bb0c
+  data.tar.gz: ae539d9c1e6923bf8c78a57359b20f951f1b9fe637f30042e2ebdca2840a5703287440999ff7a71ae0caefa9eda9ecb9d40f881111d37c4873b4fa12a8929a2b

data/.rubocop.yml

@@ -12,6 +12,8 @@ Metrics/AbcSize:
   Max: 20
 Metrics/CyclomaticComplexity:
   Max: 10
+Metrics/PerceivedComplexity:
+  Max: 10
 Metrics/BlockLength:
   Exclude: 
     - spec/**/*

data/.travis.yml

@@ -1,36 +1,38 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.0
+- 2.4.0
 env:
   global:
   - CC_TEST_REPORTER_ID=a56fc1316eb9869f9ef69353912ad37abd138ff4a594b6290c9830718ae5cd81
 before_install: gem install bundler -v 1.14.4
 before_script:
-- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
+  > ./cc-test-reporter
 - chmod +x ./cc-test-reporter
-- ./cc-test-reporter before-build
+- "./cc-test-reporter before-build"
 script:
 - bundle exec rspec
 after_script:
-- ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
 before_deploy:
 - cat ./README.md >> ./docs/index.md
 deploy:
-- provider: pages
-  skip_cleanup: true
-  github_token: "$GITHUB_TOKEN"
-  local_dir: "./docs"
-  target_branch: gh-pages
-  on:
-    branch: 
+  - provider: pages
+    skip_cleanup: true
+    github_token: "$GITHUB_TOKEN"
+    local_dir: "./docs"
+    target_branch: gh-pages
+    on:
+      branch:
       - develop
       - master
-- provider: rubygems
-  api_key:
-    secure: aZt6t60GH8ISKGw+AY/Pik1rgvYWJW0uc6Co35OlOBTNs3YitHbk5sMTq2wP0bs6qvJyPJDedAXU5F1ZEEuWz6m2wScD+Ld1hscwadNA7xcdQX6VWsJqR4biq4MkR5fLmQnTa+cDcG476J9+vL7qHJPNuiN+3jm2ODhvFlmtwtx/nXv1KgoYgpUVKBENuaVkL/7zGiFTs0nc4R32U7HGfzOGg7uXKK2JYsW5PN3KpeYVM3Df8qemVIhT6InBZvGovN1PfQ4oFV25VPLCLrQPY+qCJt54LvJQAhZVPYQaBowm1Pgg6tPA3dIHAaHI3iPKi1hOFQLoSci70OmQb7My38gWU0ARkq02eiR0uZrhkcYOuVqVU4quOGuEpagqDuWnXIz7LfnZAzfqers//TKFl/o2sLvOEfCSMZFiby6f9vk87SLyRCcsYtxYQfRBTanCgB2AlOKalSZ+WzQ4F8LvZJZbgxEoN9ul1MxHP1SeSwDlBHpXutxrX+EOfP8b/Bvi0nu8Xq2Y7HbPtfiVOXOM9aiUqWJDVaf+S5zhWd72IS54JUcCgIjeB8ryK9k1vSnfvm1VMOo7illN4MxfNNYMQk5zSeyhOLzTIQvFgALrJDGk4JtZjire0BFWUkrtEqoiD1ZuMIKWVLZbIBBMskl+bkf+VvwiubX6LibVAC4itlk=
-  gem: ghost_rb
-  on:
-    tags: true
-    repo: renehernandez/ghost_rb
-    branch: master
+  - provider: rubygems
+    api_key:
+      secure: NG9gd7Ff8Cs8LJhIjuWtbQSBRFGBBgfJ0/IKkbiMKQi3ezNKKHz1ha2jMvR6pFj8YYCkvnsO7Lj+VHCJU0SbRziPSeYxjBdDSKvOJ0K5Ui0vdFJzIZHgWJdD/C/ns60A1FnweR3cVAYBfCpquJpTKRMWmc6f1+ZRy/XzkwDOBdK9/TChzhjEO8xSHVq74EcMIwM9CO3rAnwgdzXszD5obwZ9/gIY64uivg0snxcvc5REPBEfpmn6GQ40mmIFj0tm/bF3BgE7B2h2cWEsPiUsNfl+UZy/LApJeuV8bpfL68QRcx0zGHYpMr3ZmWrZONL2dIiRN7YHXZVPCi2Fr5z5HdTrvy/WnLx3AwjJ0/j3uTHQUqRd9aqilXSqY6i68E0gaSQcrFUQts6k2AYtJzB/h+VudKxHpIcqt6zKH3O3FOcAtV15yDvQVv+krLrMPRAJ6S8idSpEkOjiNiKGjV0XpQ30B3Wchpzqr/c4ryAyb/FTPQSWLYdOd0koUeGEDBcQ9nZ0tSN58RSDyFSlk2ChZRqySQTpod2b1XzQ1NRR/hYo23C/tZB1xf1Z3MoT7cM4/T6LIsCISM5ZqJpVgY3s5E1crQxxjX1Jvy9gh28U+MABwHeZkmEDZyqC47quVn4+ArKOeuVSnJjuvgBaP7MIGZghgAT3ijIpDIbixDF31vc=
+    gem: ghost_rb
+    on:
+      tags: true
+      repo: renehernandez/ghost_rb
+      branch: master
+  

data/README.md

@@ -25,29 +25,71 @@ Or install it yourself as:
 To create a new client:
 
 ```ruby
-client = GhostRb::Client.new('URL', 'CLIENT_ID'], 'CLIENT_SECRET')
+client = GhostRb::Client.new('URL', 'CLIENT_ID', 'CLIENT_SECRET')
 ```
 
+**Note:** If parameters are not specified for resources retrieval, the default values, as specified by [Ghost API](https://api.ghost.org/), are used.
+
 #### Posts
 
-To get a list with all the blog posts, simply write:
+To access posts from the blog, first create a controller:
+
+```ruby
+ctrl = GhostRb::Controllers::PostsController.new(client) # using previous defined client var
+```
 
+A handier way to get the controller is:
 ```ruby
-status, posts = client.get_posts 
+ctrl = client.posts
 ```
 
-You can change the *limit* (defaults to all) of posts to return for the query and whether to include *author* and *tags* information.
+##### Single post by id
+
+```ruby
+post = client.posts.find_by(id: 'lhafdkaalkdfha')
+```
+
+##### Single post by slug
+
+```ruby
+post = client.posts.find_by(slug: 'welcome-to-ghost')
+```
+
+##### Get all post by setting the limit
+
+```ruby
+posts = client.posts.limit('all').all
+```
+
+##### Using where
+
+```ruby
+ctrl = client.posts
+posts = posts.where(include: 'tags, author', limit: 5).all
+```
 
 #### Tags
 
-To get a list with all the tags, write instead:
+Similarly for tags, you can create directly the controller or call it from the client instance.
+
+
+```ruby
+ctrl = GhostRb::Controllers::TagsController.new(client)
+# or
+ctrl = client.tags
+```
+
+##### All tags
 
 ```ruby
-status, tags = client.get_tags
+tags = client.tags.limit('all').all
 ```
 
-You can change the *limit* (defaults to all) of tags to return for the query and whether to include *count.posts* information.
+## Documentation
+
+The documentation lives at the [github pages](https://renehernandez.github.io/ghost_rb/). For the nitty gritty details of the implementation go to [http://www.rubydoc.info/gems/ghost_rb](http://www.rubydoc.info/gems/ghost_rb).
 
+You can also go check [this post](https://bitsofknowledge.net/2017/10/02/ghost_rb-a-ghost-rest-api-client/) where I have provided an analysis of the implementation.
 
 ## Development
 

data/lib/ghost_rb.rb

@@ -3,7 +3,8 @@
 require 'ghost_rb/version'
 require 'ghost_rb/client'
 require 'ghost_rb/errors'
-require 'ghost_rb/resources/hydratable'
+require 'ghost_rb/support/hydratable'
+require 'ghost_rb/support/hash_with_indifferent_access'
 require 'ghost_rb/resources/base_resource'
 require 'ghost_rb/resources/post'
 require 'ghost_rb/resources/user'

data/lib/ghost_rb/client.rb

@@ -10,14 +10,15 @@ module GhostRb
   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 }
+      @default_query = Support::HashWithIndifferentAccess.new(
+        client_id: @client_id,
+        client_secret: @client_secret
+      )
     end
 
     def posts
@@ -30,7 +31,10 @@ module GhostRb
 
     def get(endpoint, query)
       response = @http.get(endpoint, query, {}, follow_redirect: true)
-      content = JSON.parse(response.body)
+      content = Support::HashWithIndifferentAccess.new(
+        JSON.parse(response.body)
+      )
+
       [response.status_code, content]
     end
   end

data/lib/ghost_rb/controllers/base_controller.rb

@@ -13,7 +13,11 @@ module GhostRb
 
       def initialize(client)
         @client = client
-        @params = {}
+        @params = Support::HashWithIndifferentAccess.new
+      end
+
+      def all
+        fetch_list.map { |r| @resource_klass.generate(r) }
       end
 
       def limit(limit)
@@ -50,7 +54,8 @@ module GhostRb
           @params.delete(key)
         end
 
-        fetch_single(kvp)
+        content = fetch_single(kvp)
+        resource_klass.generate(content)
       end
 
       private
@@ -64,7 +69,7 @@ module GhostRb
           raise_fetch_single_error(kvp, status, content['errors'])
         end
 
-        resource_klass.generate(content)
+        content
       end
 
       def fetch_list
@@ -73,7 +78,7 @@ module GhostRb
 
         raise_fetch_list_error(status, content['errors']) if error?(status)
 
-        content
+        content[@endpoint]
       end
 
       def error?(status)

data/lib/ghost_rb/controllers/posts_controller.rb

@@ -13,10 +13,6 @@ module GhostRb
         @resource_klass = Resources::Post
       end
 
-      def all
-        fetch_list['posts'].map { |r| @resource_klass.generate(r) }
-      end
-
       def formats(formats)
         where(formats: formats)
       end
@@ -25,7 +21,7 @@ module GhostRb
 
       def raise_fetch_single_error(kvp, status, errors)
         key = kvp.key?(:id) ? :id : :slug
-        message = "Unable to fetch tag with #{key} = #{kvp[key]}"
+        message = "Unable to fetch post with #{key} = #{kvp[key]}"
         raise Errors::RequestError.new(message,
                                        status,
                                        errors)

data/lib/ghost_rb/controllers/tags_controller.rb

@@ -13,10 +13,6 @@ module GhostRb
         @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)

data/lib/ghost_rb/resources/base_resource.rb

@@ -7,13 +7,17 @@ module GhostRb
     # @author Rene Hernandez
     # @since 0.1
     class BaseResource
-      include Hydratable
+      include Support::Hydratable
 
       def self.generate(hash)
         res_instance = new
         res_instance.hydrate(hash)
         res_instance
       end
+
+      def self.hash_value?(data, key)
+        data.key?(key) && data[key].is_a?(Hash)
+      end
     end
   end
 end

data/lib/ghost_rb/resources/post.rb

@@ -6,17 +6,17 @@ module GhostRb
     # @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
+                    :status, :published_at, :created_at, :author,
+                    :visibility, :featured, :plaintext, :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)
+      def self.generate(data)
+        inst = super(data)
+        inst.author = User.generate(data[:author]) if hash_value?(data, :author)
+        inst.tags = data[:tags].map { |t| Tag.generate(t) } if data.key?(:tags)
 
         inst
       end

data/lib/ghost_rb/support/hash_with_indifferent_access.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module GhostRb
+  module Support
+    # rubocop:disable Metrics/LineLength
+    # Provides indifferent access for symbol and string keys.
+    # Both :bar and "bar" are considered to be the same key.
+    # This is implementation is heavily based on the
+    # [ActiveSupport implementation]{http://api.rubyonrails.org/classes/ActiveSupport/HashWithIndifferentAccess.html}
+    # @author Rene Hernandez
+    # @since 0.3
+    # rubocop:enable Metrics/LineLength
+    class HashWithIndifferentAccess < Hash
+      def initialize(data = {})
+        if data.respond_to?(:to_hash)
+          super()
+          update(data)
+
+          hash = data.to_hash
+          self.default = hash.default if hash.default
+          self.default_proc = hash.default_proc if hash.default_proc
+        else
+          super(data)
+        end
+      end
+
+      def [](key)
+        super(convert_key(key))
+      end
+
+      alias regular_writer []= unless method_defined?(:regular_writer)
+
+      def []=(key, value)
+        regular_writer(convert_key(key), convert_value(value))
+      end
+
+      def dup
+        self.class.new(self).tap do |new_hash|
+          add_defaults(new_hash)
+        end
+      end
+
+      def default(*args)
+        super(*args.map { |arg| convert_key(arg) })
+      end
+
+      def delete(key)
+        super(convert_key(key))
+      end
+
+      def fetch(key, *extras)
+        super(convert_key(key), *extras)
+      end
+
+      def key?(key)
+        super(convert_key(key))
+      end
+
+      alias has_key? key?
+
+      alias include? key?
+
+      def update(other_hash)
+        if other_hash.is_a? HashWithIndifferentAccess
+          super(other_hash)
+        else
+          other_hash.to_hash.each_pair do |key, value|
+            if block_given? && key?(key)
+              value = yield(convert_key(key), self[key], value)
+            end
+            regular_writer(convert_key(key), convert_value(value))
+          end
+          self
+        end
+      end
+
+      alias merge! update
+
+      def merge(hash, &block)
+        dup.update(hash, &block)
+      end
+
+      def to_hash
+        new_hash = {}
+        add_defaults(new_hash)
+
+        each do |key, value|
+          new_hash[key] = convert_value(value)
+        end
+        new_hash
+      end
+
+      private
+
+      def convert_key(key)
+        key.is_a?(Symbol) ? key.to_s : key
+      end
+
+      def convert_value(value)
+        return self.class.new(value) if value.is_a? Hash
+
+        return value.map { |e| convert_value(e) } if value.is_a?(Array)
+
+        value
+      end
+
+      def add_defaults(target) # :doc:
+        if default_proc
+          target.default_proc = default_proc.dup
+        else
+          target.default = default
+        end
+      end
+    end
+  end
+end

data/lib/ghost_rb/{resources → support}/hydratable.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 module GhostRb
-  module Resources
+  # Provides utility classes and modules extensions for GhostRb
+  # @author Rene Hernandez
+  # @since 0.3
+  module Support
     # @author Rene Hernandez
     # @since 0.1
     module Hydratable

data/lib/ghost_rb/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ghost_rb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Rene Hernandez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-08 00:00:00.000000000 Z
+date: 2017-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -147,10 +147,11 @@ files:
 - 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/support/hash_with_indifferent_access.rb
+- lib/ghost_rb/support/hydratable.rb
 - lib/ghost_rb/version.rb
 homepage: https://github.com/renehernandez/ghost_rb
 licenses:
@@ -172,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.1
 signing_key: 
 specification_version: 4
 summary: GhostRb is a REST API client to interact with a given Ghost blog