likeno 0.0.1.rc2 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5999e30bddb7d9b3ca7fe9d4a989c90fb3d1624d
-  data.tar.gz: 8f312491efd8109ed0f35c8b6d74f546c5f8de33
+  metadata.gz: 5ab176898e75da9879337ab0af58d81ec3cfb0ec
+  data.tar.gz: f8e4367db3a7c1912b66631ff0c51d00fca58d99
 SHA512:
-  metadata.gz: 58c18f82717d45eeaa2b4e22842da8d8a7f9b22c8b5a41c38386afc1debe4f49c59dd433bb11a4185ec8a3358864d68cb59490fc1b140e97f9bc022e6a15ae70
-  data.tar.gz: 9aede81973991cb206ba085c5802d5d04aed21c0d922fbb8ac0cda98fbb8a233ccc68e9c7ec85cdeae2679c89c3fef61158340164d3677dea2d34ef65e62c0b2
+  metadata.gz: 58c95d5df4c84165c6fa070f2201dd129c3bd3760b71cd95861254506ee1964300ce09ae1ab3b95f7dd57af8c2f57c27142b91f137e15c561ca5d1abc3d4b93a
+  data.tar.gz: 9fd72126846830c0aa96753f79d4f1f4a0c04c04f6b3693bc19d4f08e9dad9882c9fac4a91c16b5ef50c1c18019e3a6d5d3d0f40f30cad3a9d20afe2cb8d8350

data/README.md

@@ -1,16 +1,28 @@
 # Likeno
 
-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/likeno`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/mezuro/likeno.png?branch=master)](https://travis-ci.org/mezuro/likeno)
+[![Code Climate](https://codeclimate.com/github/mezuro/likeno.png)](https://codeclimate.com/github/mezuro/likeno)
+[![Test Coverage](https://codeclimate.com/github/mezuro/likeno/badges/coverage.svg)](https://codeclimate.com/github/mezuro/likeno)
 
-TODO: Delete this and the text above, and describe your gem
+Likeno is the Mezuro Team's take on RESTful APIs integration with Rails applications. It tries to mimic ActiveRecord's API.
+
+Basically back in 2013, the Mezuro team was getting started with micro services. In order to keep the code clean and following Rails' standards we looked at [active_resource](https://github.com/rails/activeresource) and it proved to not fulfill our requirements about nested objects and [her](https://github.com/remiprev/her) which also has failed the same way. With those frustations in mind we started coding all the CRUD requests using `faraday_middleware` but still giving flexibility for custom requests whenever necessary. Likeno is the final product of this.
+
+
+It's name come from the fact that by itself Likeno has no purpose at all. It only lives associated to another softwares, providing them with the necessary methods for RESTful APIs. So we can say that Likeno has a symbiosis relation with other applications. This leads us to lichens which are a good symbiosis example. As the Mezuro project has lots of Esperanto words, we finally get to Likeno: is the Esperanto word for lichen.
+
+## Contributing
+
+Please, have a look the wiki pages about development workflow and code standards:
+
+* https://github.com/mezuro/mezuro/wiki/Development-workflow
+* https://github.com/mezuro/mezuro/wiki/Standards
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'likeno'
-```
+    gem 'likeno'
 
 And then execute:
 
@@ -22,15 +34,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Likeno provides default actions for communicating with Rails applications following the scaffold routes. All communication is assumed to use JSON. Specially have a look at the methods from `Likeno::Entity`:
 
-## Development
+* C `create`
+* R `find` (retrieve)
+* U `update`
+* D `destroy`
 
-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.
+Additionally we provide other useful methods:
 
-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).
+* `save` and `save!`
+* `to_hash`
+* `==`
 
-## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/likeno.
+We hope to make available soon a full documentation on RDoc that will make easier to understand all this.
+
+A good example on how to get everything from Likeno should be KalibroClient (https://github.com/mezuro/kalibro_client). So, have a look there for some examples.
+
+### Custom Requests
+
+Likeno allows the creation of custom requests. For example:
+
+```ruby
+class MyClass
+  def my_custom_request(...)
+    action = 'my_action'
+    params = {}
+    method = :get
+    prefix = ''
+    Likeno::Entity.request(action, params, method, prefix) # The path used will be '/my_classes/my_action'
+  end
+end
+```
+
+It returns a `hash` with the response body.
+
+## Versioning
 
+Kolekti follows the [semantic versioning](http://semver.org/) policy.

data/lib/likeno/version.rb

@@ -14,5 +14,5 @@
 # along with Likeno.  If not, see <http://www.gnu.org/licenses/>.
 
 module Likeno
-  VERSION = '0.0.1.rc2'
+  VERSION = '0.0.1'
 end

data/lib/likeno.rb

@@ -22,13 +22,15 @@ module Likeno
 
   # Configure through hash
   def self.configure(opts = {})
-    @config = Hash[opts.map { |name, address| [name.to_sym, address] }]
+    opts.each do |name, address|
+      @config[name.to_sym] = address
+    end
   end
 
   # Configure through yaml file
   def self.configure_with(path_to_yaml_file)
     begin
-      @config = Psych.load_file path_to_yaml_file
+      @config.merge!(Psych.load_file(path_to_yaml_file))
     rescue Errno::ENOENT
       raise Errno::ENOENT, "YAML configuration file couldn't be found."
     rescue Psych::Exception

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: likeno
 version: !ruby/object:Gem::Version
-  version: 0.0.1.rc2
+  version: 0.0.1
 platform: ruby
 authors:
 - Heitor Reis
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,9 +184,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1