haunted 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f19cdc407073f568c9a4858c00df18db45240bd910cdee79b776d477961c36dd
+  data.tar.gz: 58b7bf117199d587c41053f4025a835f4d3e511790239ead005c0f4d5067d45b
+SHA512:
+  metadata.gz: 33754d40dea7d3ab5f74e9e25963873f6713c5fbe964132902aea888716538c83a1bfa93c358ba0c7ead2efb4d1b3a43c558259d423dd16777ee0075c6113117
+  data.tar.gz: 74a68162fd8c787b0cdf3b82b93520a7cc56c4d46a8f7f16603e349b85722673297ad746d94d54cc887ab05bc33505a96c7a49056b3d6f76b41e6f75740f6a93

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [0.1.0] - 2022-09-05
+
+- Initial release
+
+## [0.1.1] - 2022-09-06
+
+- Fix some wrong urls in the gemspec

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in haunted.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem 'rspec-file_fixtures', '~> 0.1.6'
+gem "rubocop", "~> 1.21"
+gem "webmock", "~> 3.18", ">= 3.18.1"

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    haunted (0.1.1)
+      httparty (~> 0.20.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    hashdiff (1.0.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    json (2.6.2)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_xml (0.6.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    public_suffix (5.0.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-file_fixtures (0.1.6)
+      rspec (~> 3.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.2.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  haunted!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec-file_fixtures (~> 0.1.6)
+  rubocop (~> 1.21)
+  webmock (~> 3.18, >= 3.18.1)
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Dana Holt
+
+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,108 @@
+# Haunted
+
+This gem will allow you to pull data from a Ghost CMS installation through its content API.
+
+You can read more about the Ghost CMS here:
+https://ghost.org/
+
+...and more about its content API here:
+https://ghost.org/docs/content-api/
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add haunted
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install haunted
+
+## Usage
+
+### Creating a Ghost Content API Key
+Using the gem is pretty simple.
+
+All you need is the url of your Ghost CMS site and a content API key.
+
+You can generate a content API key by going to your Ghost admin area and then Settings > Integrations.
+
+Once there you click "Add custom integration" to create a new key.
+
+## Haunted Gem Quick Start
+
+### Initializing the API client
+    
+    api = Haunted::GhostContentApi.new('https://my-ghost-cms-site.com', '{CONTENT_API_KEY}')
+
+### Getting All Resources
+There are methods to get all items for a specified type (posts, authors, tags, pages).
+
+For example, if you want to get all posts you would.
+    
+    posts = api.posts
+
+By default results are returned in pages of 15 items, but you use the paging parameter to specify the number of items
+per page and also the page number.
+
+For example, if you wanted to get all posts in a single call this would do it:
+    
+    all_posts_for_real = api.posts(paging: { limit: :all })
+
+You can also use limit with page to specify the page of results to return, this would return the second page of 
+results in pages of 5:
+    
+    page_of_posts = api.posts(paging: { limit: '5', page: '2' })
+
+### Getting Resource by ID
+If you need to get a single resource by its ID then you can use the find by id methods (posts_by_id, authors_by_id, 
+tags_by_id, pages_by_id).
+
+For example, if you want to get a post by its id:
+
+    post = api.find_by_id("6260c376eb848005f39bf06e")
+
+### Getting Resource by Slug
+Getting resources by their slug is the same as by getting them by ID. There are a set of methods (posts_by_slug, 
+authors_by_slug, tags_by_slug, pages_by_slug) for that.
+
+For example, if you want to get a post by its slug:
+
+    post = apt.find_by_slug("my-cool-post")
+
+## Including Related Resources
+All methods have an include parameter to specify related resources to return. An example of this would be a post's
+author. 
+
+You can include the author resource for a post along with it like this:
+
+    posts_with_author = api.posts(include: [:author])
+
+## Limiting Returned Fields
+If you don't need all of a resource's field you can specify when ones you need using the fields parameter. All methods
+accept this parameter.
+
+Say you wanted to only return a post's id, title, and slug.
+
+You would do it like this:
+
+    posts_with_only_certain_fields = api.posts(fields: [:id, :title, :slug])
+
+## Further Reading
+For more details on the Ghost CMS content API please take a look at the official documentation:
+
+https://ghost.org/docs/content-api/
+
+## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DanaHolt/haunted.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/haunted/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Haunted
+  VERSION = "0.1.1"
+end

data/lib/haunted.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require_relative "haunted/version"
+require "httparty"
+
+module Haunted
+  ##
+  # Client that communicates with the Ghost CMS content API
+  ##
+  class GhostContentApi
+    include HTTParty
+
+    ##
+    # Initializes a new Ghost Content API client
+    #
+    # site_url: URL to the Ghost site
+    # key: Content API key
+    # options: api_path - override the default content API path, api_version - override the default API version
+    ##
+    def initialize(site_url, key, **options)
+      @site_url = site_url
+      @key = key
+      @api_path = options[:api_path] || "ghost/api/content"
+      @api_version = options[:api_version] || "v5.0"
+    end
+
+    %w[posts authors tags pages].each do |resource_type|
+      ##
+      # Methods that get all posts, authors, tags, or pages. By default all items are returned with all
+      # properties in pages of 15 results each.
+      #
+      # include: Array of strings or symbols that specify additional related resource types to include, for example
+      # include[:tags] would include a post's tags.
+      #
+      # fields: Array of strings or symbols that specify which resource fields are returned. If you only need some
+      # fields then use this option.
+      #
+      # Available options for the include and fields options vary depending on the resource, see the Ghost Content API
+      # for more information.
+      #
+      # paging: Hash that specifies paging and limit options. Use { limit: all } to return all items. Specify a number
+      # to returned that number of items per page. Use { page: x } to specify what page of results to return.
+      ##
+      define_method(resource_type) do |include: nil, fields: nil, paging: nil|
+        self.class.get(
+          build_browse_api_endpoint(resource_type),
+          query: build_query_string_params(include: include, fields: fields, paging: paging),
+          headers: build_headers
+        )
+      end
+    end
+
+    %w[posts_by_id authors_by_id tags_by_id pages_by_id].each do |method|
+      resource_type = method.split("_").first
+
+      ##
+      # These methods (posts_by_id authors_by_id tags_by_id pages_by_id) get posts, authors, tags, or pages by
+      # the resource's id.
+      #
+      # id: id of the item you want to return
+      #
+      # include: Array of strings or symbols that specify additional related resource types to include, for example
+      # include[:tags] would include a post's tags.
+      #
+      # fields: Array of strings or symbols that specify which resource fields are returned. If you only need some
+      # fields then use this option.
+      #
+      # Available options for the include and fields options vary depending on the resource, see the Ghost Content API
+      # for more information.
+      ##
+      define_method(method) do |id, include: nil, fields: nil|
+        self.class.get(
+          build_id_api_endpoint(resource_type, id),
+          query: build_query_string_params(include: include, fields: fields),
+          headers: build_headers
+        )
+      end
+    end
+
+    %w[posts_by_slug authors_by_slug tags_by_slug pages_by_slug].each do |method|
+      resource_type = method.split("_").first
+
+      ##
+      # These methods (posts_by_slug authors_by_slug tags_by_slug pages_by_slug )get posts, authors, tags, or pages by
+      # the resource's slug.
+      #
+      # slug: slug of the item you want to return
+      #
+      # include: Array of strings or symbols that specify additional related resource types to include, for example
+      # include[:tags] would include a post's tags.
+      #
+      # fields: Array of strings or symbols that specify which resource fields are returned. If you only need some
+      # fields then use this option.
+      #
+      # Available options for the include and fields options vary depending on the resource, see the Ghost Content API
+      # for more information.
+      ##
+      define_method(method) do |slug, include: nil, fields: nil|
+        self.class.get(
+          build_slug_api_endpoint(resource_type, slug),
+          query: build_query_string_params(include: include, fields: fields),
+          headers: build_headers
+        )
+      end
+    end
+
+    ##
+    # Gets the available tiers
+    #
+    # fields: Array of strings or symbols that specify which resource fields are returned. If you only need some
+    # fields then use this option.
+    #
+    # Available options for the include and fields options vary depending on the resource, see the Ghost Content API
+    # for more information.
+    #
+    # paging: Hash that specifies paging and limit options. Use { limit: all } to return all items. Specify a number
+    # to returned that number of items per page. Use { page: x } to specify what page of results to return.
+    ##
+    def tiers(fields: nil, paging: nil)
+      self.class.get(
+        build_browse_api_endpoint("tiers"),
+        query: build_query_string_params(fields: fields, paging: paging),
+        headers: build_headers
+      )
+    end
+
+    ##
+    # Gets the settings
+    ##
+    def settings
+      self.class.get(
+        build_browse_api_endpoint("settings"),
+        query: build_query_string_params,
+        headers: build_headers
+      )
+    end
+
+    private
+
+    def build_browse_api_endpoint(type)
+      "#{@site_url}/#{@api_path}/#{type}"
+    end
+
+    def build_id_api_endpoint(type, id)
+      "#{build_browse_api_endpoint(type)}/#{id}"
+    end
+
+    def build_slug_api_endpoint(type, slug)
+      "#{build_browse_api_endpoint(type)}/slug/#{slug}"
+    end
+
+    def build_query_string_params(include: nil, fields: nil, paging: nil)
+      params = { key: @key }
+
+      params[:include] = include.join(",") unless include.nil? || include.empty?
+      params[:fields] = fields.join(",") unless fields.nil? || fields.empty?
+      params[:limit] = paging[:limit] unless paging.nil? || paging[:limit].nil? || paging[:limit].to_s.empty?
+      params[:page] = paging[:page] unless paging.nil? || paging[:page].nil? || paging[:page].to_s.empty?
+
+      params
+    end
+
+    def build_headers
+      { 'Accept-Version': @api_version }
+    end
+  end
+end

data/sig/haunted.rbs

@@ -0,0 +1,3 @@
+module Haunt
+  VERSION: String
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: haunted
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dana Holt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+description: This gem retrieves data from a Ghost CMS through the content API.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/haunted.rb
+- lib/haunted/version.rb
+- sig/haunted.rbs
+homepage: https://github.com/DanaHolt/haunted
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DanaHolt/haunted
+  source_code_uri: https://github.com/DanaHolt/haunted
+  changelog_uri: https://github.com/DanaHolt/haunted/blob/master/CHANGELOG.md
+post_install_message: BOO!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.21
+signing_key: 
+specification_version: 4
+summary: Ghost CMS Content API client
+test_files: []