spooked 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04598c9e0c15534480b494465ef37e4e15308af7
+  data.tar.gz: 21ef933d6a027dca2c02d092a66cfd934831a6cf
+SHA512:
+  metadata.gz: 2da226760388f6592d4fb9a323308d46e7724824da0ae40e45151c42f40c0df99ec0fc038afada49cfb60647c5d3f25d10364816a81dab100e7a266eff53ea67
+  data.tar.gz: 9deacc3b55431e4b536f139f9ae9e7e7c4260c93bb8fde635ab7f7ae1d4a8cd43a15575b1c66ec5b89ee37557a8f20813797c8c9bec02df452f48e528ca4f222

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# spooked Changelog
+
+An experimental (and very limited!) unofficial Ruby client for the
+[ghost.org / ghost.io blogging platform API](http://api.ghost.org/).
+
+## v0
+
+### v0.0.1 (2016-12-02)
+
+- Initial Client version
+- Initial Post.list support

data/README.md

@@ -0,0 +1,85 @@
+# spooked
+
+An experimental (and very limited!) unofficial Ruby client for the
+[ghost.org / ghost.io blogging platform API](http://api.ghost.org/).
+
+[![Gem Version](https://badge.fury.io/rb/spooked.svg)](https://badge.fury.io/rb/spooked)
+
+## Usage
+
+### Client Options
+
+If not explicitly passed a client, all methods will fall back to
+`Client.default_client`. You can set that default client directly or
+have it auto-constructed from a set of default options:
+
+#### access_token
+
+**Has no default, must be provided.**
+
+Your User Authentication Bearer Token. See
+http://api.ghost.org/docs/user-authentication for details on how to obtain that
+token.
+
+#### connection_builder
+
+**Optional**
+
+A Faraday connection builder. Defaults to:
+
+```ruby
+->(builder) {
+  builder.adapter   Faraday.default_adapter
+  builder.request   :url_encoded
+  builder.response  :parse_json
+}
+```
+
+#### connection_options
+
+**Optional**
+
+A `Hash` of options passed as the second parameter to
+`Faraday::Connection.new`.
+
+#### subdomain
+
+**Has no default, optional**
+
+For ghost.io hosted ghost instances, set this to your ghost.io subdomain, i.e.
+the word preceding `ghost.io` in the URL of your blog's administration
+interface.
+
+For self-hosted instances, you probably want to keep the `subdomain` empty and
+overwrite `url_base` instead.
+
+#### url_base
+
+**Optional**
+
+Defaults to `->(client) { "https://#{client.subdomain}.ghost.io/ghost/api/v0.1" }`.
+You should generally only overwrite this if you self-host your ghost instance.
+
+### APIs
+
+- `Posts.list(fields: nil, filter: nil, include: nil, limit: 15, order: "published_at desc", page: 1)`
+
+### Response format
+
+All responses are returned as a `Hash` with all keys and values exactly
+as described in the [API Reference Documentation](http://api.ghost.org/docs).
+
+## Compatibility
+
+So far, this has only been verified to work on Ruby (MRI) 2.3.3. I have
+no plans to support any Ruby versions below 2.3.
+
+## Status
+
+This library is in a very early stage, only supports a very limited subset of
+the API and further e.g. does not yet feature any automated tests, nor does it
+significantly transform any API responses, provide convenience helpers, etc.
+
+At the moment, The following APIs are supported:
+
+- [GET /posts/](http://api.ghost.org/docs/posts)

data/lib/spooked/api/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Spooked
+  module API
+    class Base
+      class << self
+        protected
+
+        def client
+          Client.default_client
+        end
+      end
+    end
+  end
+end

data/lib/spooked/api/posts.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Spooked
+  module API
+    class Posts < Base
+      class << self
+        def list(
+          fields:     nil,
+          filter:     nil,
+          include_:   nil, # include is a reserved keyword
+          limit:      15,
+          order:      "published_at desc",
+          page:       1
+        )
+          client.get("posts/", { params: {
+            fields:   fields,
+            filter:   filter,
+            include:  include_,
+            limit:    limit,
+            order:    order,
+            page:     page,
+          }.reject { |k, v| v.nil? } })
+        end
+      end
+    end
+  end
+end

data/lib/spooked/api.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Spooked
+  module API
+  end
+end
+
+require "spooked/api/base"
+
+require "spooked/api/posts"

data/lib/spooked/client.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Spooked
+  class Client
+    OPTIONS_WITH_CLASS_DEFAULT = [
+      :access_token,
+      :connection_builder,
+      :connection_options,
+      :subdomain,
+      :url_base,
+    ].freeze
+
+    OPTIONS_WITH_CLASS_DEFAULT.each do |option|
+      define_singleton_method(option) do
+        instance_variable_get("@#{option}")
+      end
+
+      define_singleton_method("#{option}=") do |*args|
+        instance_variable_set("@#{option}", *args)
+      end
+
+      define_method(option) do
+        instance_variable_get("@#{option}")
+      end
+
+      define_method("#{option}=") do |*args|
+        instance_variable_set("@#{option}", *args)
+      end
+    end
+
+    self.connection_builder = ->(builder) {
+      builder.adapter   Faraday.default_adapter
+      builder.request   :url_encoded
+      builder.response  :json
+    }
+
+    self.connection_options = {}
+
+    self.url_base = ->(client) {
+      "https://#{subdomain}.ghost.io/ghost/api/v0.1"
+    }
+
+    [
+      :delete,
+      :get,
+      :post,
+      :put,
+    ].each do |http_verb|
+      define_method(http_verb) do |*args|
+        connection.public_send(http_verb, *args)
+      end
+    end
+
+    def initialize(**options)
+      unknown_options = options.keys - OPTIONS_WITH_CLASS_DEFAULT
+      raise ArgumentError, "Unknown option key(s): #{unknown_options.join(", ")}. Valid options are: #{OPTIONS_WITH_CLASS_DEFAULT.join(", ")}." if unknown_options.any?
+
+      OPTIONS_WITH_CLASS_DEFAULT.each do |option|
+        value = options[option].nil? ? self.class.public_send(option) : options[option]
+        public_send("#{option}=", value)
+      end
+
+      self
+    end
+
+    protected
+
+    def connection
+      @connection ||= Faraday::Connection.new(evaluate_option(url_base), params: { access_token: access_token }, &connection_builder)
+    end
+
+    def evaluate_option(option)
+      option.is_a?(Proc) ? instance_eval(&option) : option
+    end
+
+    class << self
+      def default_client
+        @default_client ||= new
+      end
+
+      def default_client=(client)
+        @default_client = client
+      end
+    end
+  end
+end

data/lib/spooked.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+
+module Spooked
+end
+
+require "spooked/api"
+require "spooked/client"

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: spooked
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Niels Ganser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: 
+email: niels@herimedia.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- README.md
+files:
+- CHANGELOG.md
+- README.md
+- lib/spooked.rb
+- lib/spooked/api.rb
+- lib/spooked/api/base.rb
+- lib/spooked/api/posts.rb
+- lib/spooked/client.rb
+homepage: https://github.com/herimedia/spooked
+licenses:
+- Apache-2.0
+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.5.1
+signing_key: 
+specification_version: 4
+summary: An experimental unofficial API client for the ghost.org blogging platform
+test_files: []
+has_rdoc: