pernalonga 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2971eb305cf694d9ec9bf172ef12d7aff02ce78c
-  data.tar.gz: 745bf77cbccf1f85168adc5e36225d6fc6c4a769
+  metadata.gz: c29d1ca4fdc34ace351150461dc1269db89bb85a
+  data.tar.gz: cf358ae823946b36db4013b55deeb14a5c3fd0eb
 SHA512:
-  metadata.gz: 8f6e6757f2c373023f3d7b3b95765aaaeca39911ab2a9677368008b09c4d5c956dc3830b3ebbd2d05d23b0aea36d28739f11634163c29a49eabf7bb7f0f0d3d4
-  data.tar.gz: f99f254eadd8b606096f45e12dcd30cb10078fe8e89ab0b84538e77f806051248384621bfd04d865f1cea6abcd3cf7451945b921265494807a0e124868b6f697
+  metadata.gz: aeaeff18675f630e4e9aca1e513b3d9ea626c1e94639bcb90f2b79c4caa8c3e7455f468291b808c6d45ce9ae25871f53d91e2ead9346a4fb8aa18ab3699352fb
+  data.tar.gz: 9f86db90cfda347e1f910bca496d8801cde7546e016861a1805413a9129a3eedf16068630cdd4f50cdc3ce81eaad9c3a6585fd15f4b5420261fb1d5e65a21e2d

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.env

data/README.md

@@ -1,8 +1,32 @@
-# Pernalonga
+# Pernalonga [![Code Climate](https://codeclimate.com/github/fellipebrito/pernalonga/badges/gpa.svg)](https://codeclimate.com/github/fellipebrito/pernalonga) [![Test Coverage](https://codeclimate.com/github/fellipebrito/pernalonga/badges/coverage.svg)](https://codeclimate.com/github/fellipebrito/pernalonga/coverage)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pernalonga`. To experiment with that code, run `bin/console` for an interactive prompt.
+Pernalonga is a simple wrapper for the Ruby gem Bunny. While Bunny has all classes and methods for utilizing an AMQP queuing system, the code for doing so can take up a lot of space and tends to be repeated across many projects.
+
+## Usage
+Pernalonga sets up the logic of publishing and subscribing to queues and processing messages.
+
+### Connection Configuration
+Your connection configurations must be environment variables.
+
+Pernalonga uses [dotenv](https://github.com/bkeepers/dotenv) to autoload any information you have in a .env file.
+
+A sample .env file would contain the following required variables.
+```
+BUNNY_USER=abc
+BUNNY_VHOST=abc
+BUNNY_PASSWORD=abc
+BUNNY_HOST=abc
+```
+
+### Consuming
+You don’t have to setup all the Bunny objects for Connections, Channels and Queues and arrange your message processing logic within them.
+
+Instead, the only required thing is to simply implement a `process_message` method in your class. This way, once you call `Pernalonga.consume self, "queue_name"` to process messages from a queue, Pernalonga will call back your `process_message` method passing the message as the unique parameter.
+
+### Enqueuing
+To enqueue messages
+ just use `Pernalonga.enqueue "queue_name" message`.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -20,10 +44,6 @@ Or install it yourself as:
 
     $ gem install pernalonga
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## 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.
@@ -32,7 +52,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pernalonga.
+Bug reports and pull requests are welcome on GitHub at https://github.com/fellipebrito/pernalonga.
 
 
 ## License

data/Rakefile

@@ -1,7 +1,7 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new
 
-task :default => :spec
-task :test => :spec
+task default: :spec
+task test: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "pernalonga"
+require 'bundler/setup'
+require 'pernalonga'
 
 # 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.
@@ -10,5 +10,5 @@ require "pernalonga"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/pernalonga/pernalonga_api.rb

@@ -13,7 +13,7 @@ module Pernalonga
         .subscribe(consumer_tag: 'pernalonga',
                    block: true,
                    manual_ack: true) do |delivery_info, _metadata, msg = q.pop|
-        process_message msg
+        klass.process_message msg
         ch.acknowledge(delivery_info.delivery_tag, false)
       end
     end
@@ -36,9 +36,5 @@ module Pernalonga
     def connect_channel
       Bunny.new(connection_parameters).start.create_channel
     end
-
-    def process_message(message)
-      fail 'You must implement a custom process_message method' unless @klass.process_message(message)
-    end
   end
 end

data/lib/pernalonga/version.rb

@@ -1,3 +1,3 @@
 module Pernalonga
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'.freeze
 end

data/pernalonga.gemspec

@@ -4,24 +4,26 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pernalonga/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "pernalonga"
+  spec.name          = 'pernalonga'
   spec.version       = Pernalonga::VERSION
-  spec.authors       = ["Fellipe Brito"]
-  spec.email         = ["fellipe@devlandia.net"]
+  spec.authors       = ['Fellipe Brito']
+  spec.email         = ['fellipe@devlandia.net']
 
-  spec.summary       = %q{Provide a wrapper to Rabbit+Bunny enqueuement system.}
-  spec.description   = %q{Provide a wrapper to Rabbit+Bunny enqueuement system.}
+  spec.summary       = 'Provide a wrapper to Rabbit+Bunny enqueuement system.'
+  spec.description   = 'Provide a wrapper to Rabbit+Bunny enqueuement system.'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.8'
+  spec.add_development_dependency 'rubocop', '~> 0.36.0'
+  spec.add_development_dependency 'simplecov', '~> 0.11.1'
 
-  spec.add_runtime_dependency 'dotenv'
-  spec.add_runtime_dependency 'bunny'
+  spec.add_runtime_dependency 'dotenv', '2.1.0'
+  spec.add_runtime_dependency 'bunny', '2.2.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pernalonga
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Fellipe Brito
@@ -52,48 +52,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.8
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.36.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.36.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.11.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.11.1
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.2
 description: Provide a wrapper to Rabbit+Bunny enqueuement system.
 email:
 - fellipe@devlandia.net