spooky 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb5305d1096b3ab7ae0add591dad425ae012cb2105b3a7a0d64691352c28d7c5
+  data.tar.gz: 576d6d09c71cdc9cd6aba580d3386b80e750f314a9a2509cd49e60401dea76f3
+SHA512:
+  metadata.gz: a8eaf6a4cabc7d44952a84eefbb7d821451d8ac9863c52240de3c10f2da1424ae3065001855b3a4df37ac110144cc71a5f468b46d1d600465c3560f8cbb89ee9
+  data.tar.gz: 32621bc47059575a6f909b2b3ac6e2be2332aa7218a234243db9a615d08e0d5ea33038458234f47816a0a71bf2fe016e65d30f312138582afab157d3bcfd8603

data/.gitignore

@@ -0,0 +1,10 @@
+.env
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+AllCops:
+  NewCops: enable

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.6
+before_install: gem install bundler -v '~> 2.0'
+script: bundle exec rspec spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Contributor Code of Conduct
+
+This project adheres to this document: https://www.contributor-covenant.org/version/2/0/code_of_conduct/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ritchie Blair
+
+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,95 @@
+# :ghost: Spooky
+
+[![Build Status](https://travis-ci.com/togethr/spooky.svg?branch=master)](https://travis-ci.com/togethr/spooky)
+
+A simple Ruby wrapper for the [Ghost](https://ghost.org) Content API.
+
+The Ghost Content API documentation can be found [here](https://ghost.org/docs/api/v3/content/#endpoints).
+
+## Installation
+
+Add spooky to your Gemfile:
+
+```ruby
+gem "spooky"
+```
+
+And then run:
+
+    $ bundle
+
+## Usage
+
+To get started, a Ghost client needs to be initialized using the API URL of your Ghost installation and its content API key.
+
+### Initializing a client (`Spooky::Client`)
+
+#### Initialize manually
+
+A client can be created by running the below with your credentials:
+
+```ruby
+client = Spooky::Client.new(api_url: "https://blog.yourdomain.com", api_key: "abc123")
+```
+#### Initialize with ENV variables
+
+Spooky also has ENV variable support out of the box. You can set your credentials by setting the below ENV variables:
+
+Attribute     | ENV variable
+:------------ | :--------------------
+api_url       | `GHOST_API_URL`
+api_key       | `GHOST_CONTENT_API_KEY`
+
+If they above are set then all you have to do to initialize a client is:
+
+```ruby
+client = Spooky::Client.new
+```
+### Fetching Posts
+
+Spooky operates primarily on posts.
+
+#### Get all posts
+`posts = client.posts`
+
+Returns an array of `Spooky::Post`s.
+
+#### Get all posts and include tags and authors
+`posts = client.posts(tags: true, authors: true)`
+
+Returns an array of `Spooky::Post`s with `Spooky::Tag`s and `Spooky::Author`s where appropriate.
+
+#### Get a post by ID or slug
+
+`post = client.post_by(id: 'abc123')`
+
+`post = client.post_by(slug: 'this-is-a-slug')`
+
+Both return a `Spooky::Post`.
+
+#### Get posts with a filter applied
+
+Filtering accepts simple hashes as conditions or NQL strings for more complex filters.
+
+`featured_posts = client.posts(filter: { featured: true })`
+
+`welcome_posts = client.posts(filter: "title:Welcome")`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Create an issue with your comments or request or open a pull request with your change and accompanying tests.
+This project adheres to the included Code of Conduct, see CODE_OF_CONDUCT.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Credits
+
+This gem was originally developed by [infinityrobot](https://github.com/infinityrobot).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "spooky"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/spooky.rb

@@ -0,0 +1,7 @@
+require "spooky/version"
+
+require "spooky/is_resource"
+require "spooky/client"
+require "spooky/post"
+require "spooky/author"
+require "spooky/tag"

data/lib/spooky/author.rb

@@ -0,0 +1,21 @@
+module Spooky
+  class Author
+    ATTRIBUTES = [
+      "bio",
+      "cover_image",
+      "facebook",
+      "id",
+      "location",
+      "meta_description",
+      "meta_title",
+      "name",
+      "profile_image",
+      "slug",
+      "twitter",
+      "url",
+      "website"
+    ].freeze
+
+    include IsResource
+  end
+end

data/lib/spooky/client.rb

@@ -0,0 +1,75 @@
+require "http"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/string/inflections"
+
+module Spooky
+  class Client
+    attr_accessor :api_url, :api_key, :endpoint, :error
+
+    def initialize(attrs = {})
+      @api_url = ENV["GHOST_API_URL"] || attrs[:api_url]
+      @api_key = ENV["GHOST_CONTENT_API_KEY"] || attrs[:api_key]
+      @endpoint = "#{@api_url}/ghost/api/v3/content"
+    end
+
+    def fetch_json(resource, options = {})
+      options.merge!(key: @api_key)
+      url = "#{@endpoint}/#{resource}/"
+      response = HTTP.get(url, params: options).parse
+
+      if response["errors"].present?
+        @error = response["errors"]
+        false
+      else
+        response[resource.split("/").first]
+      end
+    end
+
+    def fetch(resource, options = {})
+      resource_name = resource.split("/").first
+      response = fetch_json(resource, options)
+
+      resource_class = "Spooky::#{resource_name.singularize.classify}".constantize
+
+      response.present? && response.map { |attrs| resource_class.send(:new, attrs) }
+    end
+
+    def posts(tags: false, authors: false, filter: false)
+      inc = []
+      inc << "tags" if tags
+      inc << "authors" if authors
+
+      options = {}
+      options[:include] = inc if inc.present?
+
+      if filter.present?
+        if filter.is_a?(Hash)
+          options[:filter] = filter.map { |k, v| "#{k}:#{v}" }.join
+        else
+          options[:filter] = filter
+        end
+      end
+
+      fetch("posts", options)
+    end
+
+    def post_by(id: nil, slug: nil, tags: false, authors: false)
+      inc = []
+      inc << "tags" if tags
+      inc << "authors" if authors
+
+      options = {}
+      options[:include] = inc if inc.present?
+
+      if id.present?
+        response = fetch("posts/#{id}", options)
+        response.present? && response.first
+      elsif slug.present?
+        response = fetch("posts/slug/#{slug}", options)
+        response.present? && response.first
+      else
+        false
+      end
+    end
+  end
+end

data/lib/spooky/is_resource.rb

@@ -0,0 +1,26 @@
+module IsResource
+  def self.included(base)
+    base.class_eval do
+      attr_reader(*const_get("ATTRIBUTES"))
+
+      def initialize(attrs = {})
+        self.class.const_get("ATTRIBUTES").each do |attribute|
+          instance_variable_set("@#{attribute}", attrs[attribute])
+        end
+
+        parse_datetimes(attrs)
+        parse_attributes(attrs)
+      end
+
+      def parse_datetimes(attrs)
+        ["created_at", "updated_at", "published_at"].each do |date_attr|
+          instance_variable_set("@#{date_attr}", DateTime.iso8601(attrs[date_attr])) if attrs[date_attr].present?
+        end
+      end
+
+      def parse_attributes(attrs)
+        # Abstract method, should be overridden in child if needed.
+      end
+    end
+  end
+end

data/lib/spooky/post.rb

@@ -0,0 +1,58 @@
+module Spooky
+  class Post
+    ATTRIBUTES = [
+      "authors",
+      "canonical_url",
+      "codeinjection_foot",
+      "codeinjection_head",
+      "comment_id",
+      "created_at",
+      "custom_excerpt",
+      "custom_template",
+      "email_subject",
+      "excerpt",
+      "feature_image",
+      "featured",
+      "html",
+      "id",
+      "meta_description",
+      "meta_title",
+      "og_description",
+      "og_image",
+      "og_title",
+      "primary_author",
+      "primary_tag",
+      "published_at",
+      "reading_time",
+      "send_email_when_published",
+      "slug",
+      "tags",
+      "title",
+      "twitter_description",
+      "twitter_image",
+      "twitter_title",
+      "updated_at",
+      "url",
+      "uuid",
+      "visibility"
+    ].freeze
+
+    include IsResource
+
+    def parse_attributes(attrs)
+      author = attrs["primary_author"]
+      @primary_author = author.present? && Spooky::Author.new(author)
+
+      @authors = (attrs["authors"] || []).map do |author|
+        Spooky::Author.new(author)
+      end
+
+      tag = attrs["primary_tag"]
+      @primary_tag = tag.present? && Spooky::Tag.new(tag)
+
+      @tags = (attrs["tags"] || []).map do |tag|
+        Spooky::Tag.new(tag)
+      end
+    end
+  end
+end

data/lib/spooky/tag.rb

@@ -0,0 +1,17 @@
+module Spooky
+  class Tag
+    ATTRIBUTES = [
+      "description",
+      "feature_image",
+      "id",
+      "meta_description",
+      "meta_title",
+      "name",
+      "slug",
+      "url",
+      "visibility"
+    ].freeze
+
+    include IsResource
+  end
+end

data/lib/spooky/version.rb

@@ -0,0 +1,3 @@
+module Spooky
+  VERSION = "1.0.0".freeze
+end

data/spooky.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "spooky/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "spooky"
+  spec.version       = Spooky::VERSION
+  spec.authors       = ["Georges Gabereau"]
+  spec.email         = ["georges@togethr.app"]
+
+  spec.summary       = "A simple Ruby wrapper for the Ghost Content API."
+  spec.description   = "Access the Ghost Content API via Ruby."
+  spec.homepage      = "https://github.com/togethr/spooky"
+  spec.license       = "MIT"
+
+  file_match = %r{^(test|spec|features)/}
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(file_match) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", "~> 6.0"
+  spec.add_runtime_dependency "http", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "dotenv", "~> 2.7"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "rubocop", "~> 0.89.0"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: spooky
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Georges Gabereau
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.0
+description: Access the Ghost Content API via Ruby.
+email:
+- georges@togethr.app
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/spooky.rb
+- lib/spooky/author.rb
+- lib/spooky/client.rb
+- lib/spooky/is_resource.rb
+- lib/spooky/post.rb
+- lib/spooky/tag.rb
+- lib/spooky/version.rb
+- spooky.gemspec
+homepage: https://github.com/togethr/spooky
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple Ruby wrapper for the Ghost Content API.
+test_files: []