pnut 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ba2df58d128250d60431551a4435cb516251aa8491c311d90de848c036467f4
+  data.tar.gz: 8d67246e929c27a53595c9f4f2640ce4592ffbd18547572a2465fc512d5f372c
+SHA512:
+  metadata.gz: f458240e88df536c1b9720da6ec71f634ecb9a6d460bb22e0e9a8431d153717e1c452b996421b75ecb604329924c1f8e17ac1245b974f294258a882453d1a69e
+  data.tar.gz: 24a485265066d33b57488270104fc856a5429632ba99c673faf493016c2b9c7d7844368afa2303ba7409266f3e5d598db17067c628bdcc83c1cf74869c176b1f

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pnut.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    pnut (0.1.0)
+      addressable (~> 2.5)
+      faraday
+      webmock (~> 3.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.7)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    safe_yaml (1.0.4)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  pnut!
+  pry (~> 0.11)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kai Wood
+
+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,67 @@
+# pnut
+
+Convenient wrapper library around the [pnut.io](https://pnut.io) API for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pnut'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pnut
+
+## Usage
+
+The goal of the project is to provide a convenient method for every possible endpoint. For example, if you want to fetch the global timeline and get back an array containing "meta" and "data" as described in the [official documentation of the pnut.io API](https://pnut.io/docs/api/implementation/overview):
+
+```ruby
+require "pnut"
+
+pnut = Pnut::Client.new
+pnut.global
+```
+
+Check the docs for an overview to all implemented methods.
+
+If we didn't implement an endpoint yet, you can use the `request` method to send custom requests:
+
+```ruby
+require "pnut"
+
+pnut = Pnut::Client.new
+pnut.request("/posts/streams/global")
+```
+
+```ruby
+require "pnut"
+
+pnut.request(
+  "/channels/123/messages",
+  method: "POST",
+  data: {
+    text: "Der Test[tm]"
+  }
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kaiwood/pnut-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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pnut"
+
+@pnut = Pnut::Client.new(authorization_token: ENV["PNUT_TOKEN"])
+
+require "pry"
+Pry.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/pnut/posts.rb

@@ -0,0 +1,15 @@
+module Posts
+  # <em>GET /posts/streams/global</em>
+  #
+  # A stream of all users' public posts.
+  def global(**args)
+    self.request("/posts/streams/global", params: args)
+  end
+
+  # <em>GET /posts/streams/unified</em>
+  #
+  # A combined Personal Stream including the authenticated user's mentions.
+  def unified(**args)
+    self.request("/posts/streams/unified", params: args)
+  end
+end

data/lib/pnut/version.rb

@@ -0,0 +1,3 @@
+module Pnut
+  VERSION = "0.1.0"
+end

data/lib/pnut.rb

@@ -0,0 +1,37 @@
+require "pnut/version"
+require "pnut/posts"
+require "faraday"
+require "json"
+require "ostruct"
+require "addressable/uri"
+
+module Pnut
+  class Client
+    include Posts
+
+    def initialize(authorization_token: nil)
+      @token = authorization_token
+      @connection = Faraday.new("https://api.pnut.io/")
+    end
+
+    def request(endpoint, method: "GET", params: nil, data: nil, raw_response: false)
+      prepared_endpoint = "/v0#{endpoint}"
+
+      if params
+        uri = Addressable::URI.new
+        uri.query_values = params
+        prepared_endpoint += "?#{uri.query}"
+      end
+
+      response = @connection.send(method.downcase.to_sym, prepared_endpoint) do |req|
+        req.url prepared_endpoint
+        req.headers["Content-Type"] = "application/json"
+
+        req.headers["Authorization"] = "Bearer #{@token}" if @token
+        req.body = data.to_json if data
+      end
+
+      raw_response ? response.body : JSON.parse(response.body, object_class: OpenStruct)
+    end
+  end
+end

data/pnut.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pnut/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "pnut"
+  spec.version = Pnut::VERSION
+  spec.authors = ["Kai Wood"]
+  spec.email = ["kwood@kwd.io"]
+
+  spec.summary = %q{Convenient wrapper library around the [pnut.io](https://pnut.io) API}
+  spec.homepage = "https://github.com/kaiwood/pnut-ruby"
+  spec.license = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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"
+  spec.add_dependency "webmock", "~> 3.4"
+  spec.add_dependency "addressable", "~> 2.5"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry", "~> 0.11"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: pnut
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kai Wood
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: 
+email:
+- kwood@kwd.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pnut.rb
+- lib/pnut/posts.rb
+- lib/pnut/version.rb
+- pnut.gemspec
+homepage: https://github.com/kaiwood/pnut-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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Convenient wrapper library around the [pnut.io](https://pnut.io) API
+test_files: []