act_as_pingback 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '098eb701c7b808f79d700c91def8b713516e28b631bec21672ec9339e1d94df8'
+  data.tar.gz: 07c81eeea1617870e7ace72e3767e60055ead8144a2ab1ee76b189079907ae43
+SHA512:
+  metadata.gz: 5bd17c2d2ac02f76a6688f12c9f91fa97e602ffc66a83076fb0784c3528ced3ed1c98bd1aa8f87fb3e913008571b34ba6ed34582898f656b7dd1381cf23dc02d
+  data.tar.gz: 0cbe057e07083219809a289633e6480792fe57d2963a7bc95d8a95f92bb865a596cf1bc7713477c003a2bb17ce430567a7fbb14ea1f2fd27d47b0dc5b8013822

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Myk Klemme
+
+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,144 @@
+# act_as_pingback
+
+[![IHV](https://img.shields.io/badge/member%20of-Invisible%20Hat%20Ventures-blue.svg)](https://github.com/invisiblehats)
+
+---
+
+A rails integration for [pingback-ruby](https://github.com/democracy-news/pingback-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'act_as_pingback', github: 'democracy-news/act_as_pingback'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install act_as_pingback
+
+## Usage
+You need to create a free account [here](#) before using this gem.
+```ruby
+Pingback.configure do |config|
+  config.api_token = ENV['PINGBACK_TOKEN']
+end
+```
+
+Install `act_as_pingback` in the models you want and enable which fields you want to include in the pingback:
+
+```ruby
+class Post < ApplicationRecord
+  act_as_pingback fields: [
+                    :title,
+                    :body,
+                    :url
+                  ]
+end
+```
+
+This would send a request to `pingback.democracy.news` with:
+
+```ruby
+{
+  title: "Hello world",
+  body: "<p>I created this using a tutorial from https://google.com and <a href=\"https://code.tutsplus.com/\">envato</a></p>",
+  url: "https://myblog.com/posts/hello-world"
+}
+```
+
+on `post#create` and `post#update` `post#delete` by default.
+
+`url` by default will be `Rails.application.routes.url_helpers.url(self)`. To override this:
+```ruby
+class Post < ApplicationRecord
+  act_as_pingback fields: [
+                    :formatted_title,
+                    :body,
+                    :url
+                  ],
+                  callbacks: false,
+                  on: [
+                    :create
+                  ],
+                  async: true,
+                  queue: 'cms'
+
+    def url
+      "https://myotherblog.com/posts/#{slug}"
+    end
+
+    def formatted_title
+      "[POST] #{title}"
+    end
+end
+```
+
+Becomes:
+
+```ruby
+{
+  title: "[POST] Hello world",
+  body: "<p>I created this using a tutorial from https://google.com and <a href=\"https://code.tutsplus.com/\">envato</a></p>",
+  url: "https://myotherblog.com/posts/hello-world"
+}
+```
+
+### Options
+Argument | Type | Default | Description
+--|--|--|--
+`fields` | `Array` (symbols) | `[]` | A list of the fields to include in the request. These would be any with links to process.
+`callbacks` | `Boolean` | `true` | Trigger on active record callbacks? _(Only enabled for `ActiveRecord` objects)_
+`on` | `Array` | `:create, :update, :delete` | Which lifecycle events should this library fire for
+`async` | `Boolean` | `false` | Should this be run in the background?
+`queue` | `String` | `default` | The queue name for this to run in _(Only supports `Sidekiq` right now)_
+
+```ruby
+# example
+class Post < ApplicationRecord
+  act_as_pingback fields: [
+                    :title,
+                    :body,
+                    :url
+                  ],
+                  callbacks: false,
+                  on: [
+                    :create
+                  ],
+                  async: true,
+                  queue: 'cms'
+
+end
+```
+
+
+## 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/democracy-news/act_as_pingback. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ClassName project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/democracy-news/act_as_pingback/blob/master/CODE_OF_CONDUCT.md).
+
+## Development team
+### People
+- [Myk Klemme - @mklemme](https://github.com/mklemme) Lead developer and maintainer for this project.
+### Partners
+- [Invisible Hat Ventures - @invisiblehats](https://github.com/invisiblehats) A private startup development agency
+- [Love.irish - @love-irish](https://github.com/love-irish) A lifestyle-as-a-service for the Irish language
+- [League of Celts - @league-of-celts](https://github.com/league-of-celts) A non-profit focused on promoting Celtic languages

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActAsPingback'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/act_as_pingback.rb

@@ -0,0 +1,5 @@
+require "act_as_pingback/railtie"
+
+module ActAsPingback
+  # Your code goes here...
+end

data/lib/act_as_pingback/railtie.rb

@@ -0,0 +1,4 @@
+module ActAsPingback
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/act_as_pingback/version.rb

@@ -0,0 +1,3 @@
+module ActAsPingback
+  VERSION = '0.1.1'
+end

data/lib/tasks/act_as_pingback_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :act_as_pingback do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: act_as_pingback
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Myk Klemme
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A rails engine for publishing updates to pingback.democracy.news
+email:
+- mykklemme@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/act_as_pingback.rb
+- lib/act_as_pingback/railtie.rb
+- lib/act_as_pingback/version.rb
+- lib/tasks/act_as_pingback_tasks.rake
+homepage: https://github.com/democracy-news/act_as_pingback
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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 rails engine for publishing updates to pingback.democracy.news
+test_files: []