clashinator 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10b71b1313b2e9eab1c142bdb52b9ece293d75c9
-  data.tar.gz: 9b1bd1dfa94569ac0be33f477c783c148d2d1562
+  metadata.gz: 237e6890b9e9d6645c7908ea43fee68831d88a9c
+  data.tar.gz: 539ec575c05a83d7bbadd1dc00eb3e4f966ee5d4
 SHA512:
-  metadata.gz: 553867236c9c2ab15fd15b77596751f5b704e782faacfbcb3359fda132262cc409d35ef77cd223123ffe2be3e9fc336088ddd6689c65a781f86f15c801a8d455
-  data.tar.gz: e9d70df33652c36ef7795dbee62496cda19a4fefdaf2d682c900cde2685bb23f50499fafe057cbe7c320d4fd21aa056d3ee88e43665448b4828b78de2ed5b4f1
+  metadata.gz: c926386fbce2b6cc200799ce764eb42557aa8741ed7d5a51a23e600b457f3bcfa038702a7d8552db74d178c56a07600804f993db86c15e0cb8fe5a25dc650607
+  data.tar.gz: 44fa2ba2b94ba03e9b10cd00d3b6ca6426838f192e5735f25ff98e2f3847ab8d0a9c3ceb90bb38b71882e07c615395847af86a58651e52a75830a6f06da0ff8d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clashinator (0.1.0)
+    clashinator (0.1.2)
       faraday (~> 0.9.2)
       faraday_middleware (~> 0.10)
 

data/README.md

@@ -1,8 +1,6 @@
 # Clashinator
 
-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/clashinator`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ruby wrapper for the Clash of Clans API
 
 ## Installation
 
@@ -22,7 +20,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You'll need to generate an access token in Clash of Clans developer page at:
+[https://developer.clashofclans.com](https://developer.clashofclans.com)
+
+With your access token, retrieve a client instance with it.
+
+`client = Clashinator::Client.new('YOUR TOKEN')`
+
+To retrieve objects(for now JSON data), you can perform this actions, defined in the Clash of Clans API docs:
+
+```ruby
+client.find_clan({name: 'onehive', minMembers: 25})
+
+client.get_clan_info({clan_tag: '#2U2CYPQ8'})
+
+client.list_clan_members({clan_tag: '#2U2CYPQ8'})
+
+client.list_locations()
+
+client.get_location_info({location_id: 32000254})
+
+client.get_ranking_for_location({location_id: 32000254, ranking_id: 'clans'})
+```
 
 ## Development
 
@@ -32,7 +51,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]/clashinator. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/leocabeza/clashinator. 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

data/lib/clashinator/exceptions/response_error.rb

@@ -7,10 +7,10 @@ module Clashinator
         @response = response
       end
 
-      def to_s
-        super +
-          format(' (%s)', data.map { |k, v| %(#{k}: "#{v}") }.join(', '))
-      end
+      #def to_s
+      #  super +
+      #    format(' (%s)', data.map { |k, v| %(#{k}: "#{v}") }.join(', '))
+      #end
 
       #def error_code
       #  data[:error_code] || data['error_code']
@@ -22,7 +22,7 @@ module Clashinator
         @data ||= begin
           JSON.parse(response.body)
         rescue JSON::ParserError
-          { error_code: response.status, uri: response.env.url.to_s }
+          { error_code: response.status, reason: response.body.reason }
         end
       end
     end

data/lib/clashinator/version.rb

@@ -1,3 +1,3 @@
 module Clashinator
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clashinator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Leonardo Cabeza