jahuty 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 948fab3c8b8bda77a94f6a69efaf79d4529a2bd26d5183eea758e143bac819d6
+  data.tar.gz: 0f8dfaf771f9d50926b1c8042da5e1a121c6f42ad0af5b2ba4879fd8d7663b67
+SHA512:
+  metadata.gz: b8a73aa645e540e01355ebc3d75445cafe611b33e3e610bc3b327472f5ed608ea0839f21977348dd8d9a6b69b2c1369f450ae15a9ae7917103c1835e5da0bf1f
+  data.tar.gz: dfe0afb290abd658c8a2fef352e36aa0141b63e17282bfb476b1829dd32229ffa157eb7b1ba40d77e084a2d3897a3b6cd304545f1058b95a44464f594a3f8a2f

data/.gitignore

@@ -0,0 +1,45 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# RSpec artifacts
+.rspec_status
+
+# Used by dotenv library to load environment variables.
+.env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 1.0.0 - 2020-03-08
+
+- Update `rake` version.
+- Move API key to `Jahuty` object from `Snippet` object.
+- Rename gem to `jahuty` from `jahuty-snippet`.
+- Rename repository to `jahuty-ruby` from `snippets-ruby`.
+- Add `CHANGELOG.md`.
+
+## 0.1.0 - 2019-09-07
+
+- Initial release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 jahuty
+
+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,93 @@
+# jahuty-ruby
+Welcome [Jahuty's](https://www.jahuty.com) Ruby SDK!
+
+## Installation
+
+This library requires [Ruby 2.3+](https://www.ruby-lang.org/en/downloads/releases/).
+
+It is multi-platform, and we strive to make it run equally well on Windows, Linux, and OSX.
+
+Add this line to your application's `Gemfile`, where `x` is the latest major version number:
+
+```ruby
+gem "jahuty", "~> x"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+Before use, the library needs to be configured with your [API key](https://www.jahuty.com/docs/api#authentication) (ideally, once during startup):
+
+```ruby
+require "jahuty"
+
+Jahuty.key = "YOUR_API_KEY"
+```
+
+With the API key set, you can use the `get()` method to retrieve a snippet:
+
+Then, use the `.get` method to fetch a snippet:
+
+```ruby
+require "jahuty"
+
+# retrieve the snippet
+snippet = Snippet.get YOUR_SNIPPET_ID
+
+# convert it to a string
+snippet.to_s
+
+# or, access its attributes
+snippet.id
+snippet.content
+```
+
+In an HTML view:
+
+```html+erb
+<%-
+require "jahuty"  
+
+Jahuty.key = "YOUR_API_KEY"
+%>
+<!doctype html>
+<html>
+<head>
+    <title>Awesome example</title>
+</head>
+<body>
+    <%= Snippet.get YOUR_SNIPPET_ID %>
+</body>
+```
+
+If you don't set your API key before calling `Snippet.get`, a `StandardError` will be raised. If an error occurs with [Jahuty's API](https://www.jahuty.com/docs/api), a `NotOk` exception will be raised:
+
+```ruby
+require "jahuty"
+
+begin
+  Snippet.get YOUR_SNIPPET_ID
+rescue StandardError => e
+  # hmm, did you set the API key first?
+rescue Jahuty::Exception::NotOk => e
+  # hmm, the API returned something besides 2xx status code
+  puts e.problem.type    # a URL to more information
+  puts e.problem.status  # the status code
+  puts e.problem.detail  # a description of the error
+end
+```
+
+That's it!
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/jahuty/snippets-ruby).
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jahuty/snippets"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/jahuty.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "jahuty"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jahuty"
+  spec.version       = Jahuty::VERSION
+  spec.authors       = ["Jack Clayton"]
+  spec.email         = ["jack@jahuty.com"]
+
+  spec.summary       = %q{Jahuty's Ruby SDK.}
+  spec.description   = %q{Turn any page into a content-managed page.}
+  spec.homepage      = "https://github.com/jahuty/jahuty-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '~> 0.1'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/jahuty.rb

@@ -0,0 +1,23 @@
+require "jahuty/version"
+
+require "jahuty/snippet"
+
+require "jahuty/data/problem"
+require "jahuty/data/snippet"
+
+require "jahuty/exception/not_ok"
+
+require "jahuty/service/connect"
+require "jahuty/service/get"
+
+module Jahuty
+  @key
+
+  class << self
+    attr_accessor :key
+
+    def key?
+      !(@key.nil? || @key.empty?)
+    end
+  end
+end

data/lib/jahuty/data/problem.rb

@@ -0,0 +1,21 @@
+module Jahuty
+  module Data
+    class Problem
+      attr_accessor :status, :type, :detail
+
+      def initialize(status, type, detail)
+        @status = status
+        @type   = type
+        @detail = detail
+      end
+
+      def self.from(data)
+        raise ArgumentError.new "Key :status does not exist" if !data.key?(:status)
+        raise ArgumentError.new "Key :type does not exist" if !data.key?(:type)
+        raise ArgumentError.new "Key :detail does not exist" if !data.key?(:detail)
+
+        Problem.new(data[:status], data[:type], data[:detail])
+      end
+    end
+  end
+end

data/lib/jahuty/data/snippet.rb

@@ -0,0 +1,23 @@
+module Jahuty
+  module Data
+    class Snippet
+      attr_accessor :id, :content
+
+      def initialize(id, content)
+        @id      = id
+        @content = content
+      end
+
+      def self.from(data)
+        raise ArgumentError.new "Key :id does not exist" if !data.key?(:id)
+        raise ArgumentError.new "Key :content does not exist" if !data.key?(:content)
+
+        Snippet.new(data[:id], data[:content])
+      end
+
+      def to_s
+        @content
+      end
+    end
+  end
+end

data/lib/jahuty/exception/not_ok.rb

@@ -0,0 +1,15 @@
+module Jahuty
+  module Exception
+    class NotOk < ::StandardError
+      attr_reader :problem
+
+      def initialize(problem)
+        @problem = problem
+      end
+
+      def message
+        "The API responded with #{@problem.status}, #{@problem.type}: #{@problem.detail}"
+      end
+    end
+  end
+end

data/lib/jahuty/service/connect.rb

@@ -0,0 +1,23 @@
+require "faraday"
+
+module Jahuty
+  module Service
+    class Connect
+      URL = "https://www.jahuty.com/api/snippets"
+
+      HEADERS  = {
+        "Accept":          "application/json;q=0.9,*/*;q=0.8",
+        "Accept-Encoding": "gzip, deflate",
+        "Content-Type":    "application/json; charset=utf-8",
+        "User-Agent":      "Jahuty Ruby client #{::Jahuty::VERSION}"
+      }
+
+      def call(key)
+        Faraday.new(
+          url: URL,
+          headers: {"Authorization": "Bearer #{key}"}.merge(HEADERS)
+        )
+      end
+    end
+  end
+end

data/lib/jahuty/service/get.rb

@@ -0,0 +1,24 @@
+require "json"
+
+module Jahuty
+  class Service::Get
+    @connection
+
+    def initialize(connection)
+      @connection = connection
+
+    end
+
+    def call(id)
+      response = @connection.get(id.to_s)
+
+      payload = JSON.parse(response.body, symbolize_names: true)
+
+      if response.status != 200
+        raise Exception::NotOk.new(Data::Problem.from(payload))
+      end
+
+      return Data::Snippet.from(payload)
+    end
+  end
+end

data/lib/jahuty/snippet.rb

@@ -0,0 +1,13 @@
+module Jahuty
+  class Snippet
+    @@get
+
+    def self.get(id)
+      raise "API key not set. Did you use Jahuty.key?" unless Jahuty.key?
+
+      @@get ||= Service::Get.new(Service::Connect.new.call(Jahuty.key))
+
+      @@get.call(id)
+    end
+  end
+end

data/lib/jahuty/version.rb

@@ -0,0 +1,3 @@
+module Jahuty
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: jahuty
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jack Clayton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !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'
+description: Turn any page into a content-managed page.
+email:
+- jack@jahuty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jahuty.gemspec
+- lib/jahuty.rb
+- lib/jahuty/data/problem.rb
+- lib/jahuty/data/snippet.rb
+- lib/jahuty/exception/not_ok.rb
+- lib/jahuty/service/connect.rb
+- lib/jahuty/service/get.rb
+- lib/jahuty/snippet.rb
+- lib/jahuty/version.rb
+homepage: https://github.com/jahuty/jahuty-ruby
+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: Jahuty's Ruby SDK.
+test_files: []