cdg-services 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f65edfe2bf757f62b6571da3f5434d81e8bacecc
-  data.tar.gz: 74f7996b2f294adb7075c531c94a1c3098ebc410
+  metadata.gz: aaa8ff22fb0a0aac4fdd1d7ecefbe1990cf35d9d
+  data.tar.gz: 16a868e0632c73d9be64f5e49fa29ef6f64a03a9
 SHA512:
-  metadata.gz: bf1b25102cb84298aa7d25b1c732687a51490f1d2d359b9f3453cf905b1c1655e694f7826a58a32fc75b2bf1568097be33bfdcbde3c2a413bd371f4aeb9d41f3
-  data.tar.gz: 907eaf6642c25a078cc729f6834c78160c81acfcffb77d5e68af10dc989590460ac0f4a378f5d852398824cddc468b407ed3acce9e7a2e2455fe5f12e4002b12
+  metadata.gz: 583b196d9d636cb3fed5dfe8ab93a6c67c8d5c1273fb044e19722a59ec2ed1fc5afa988e2d1454ecbe7b6fed0db6d81827c7b0d2d41011442caf3eaecc83c449
+  data.tar.gz: fa01d0c139db7191b837d35e5840321970fd9467b2918e1a8b60972140cb4cbec6a1cf7111d6e989bf2ceb449f16da367f8e2876d128620d09094a611f19e176

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.2] - 2017-07-07
+### Added
+- Add method(`CDG::Services.ping_slack!`) to send notification to slack with some custom params
+
+### Changed
+- Rename method `CDG::Services.GetIOSVersion` to `CDG::Services.get_ios_version` to follow ruby naming conventions
+- Rename method `CDG::Services.GetAndroidVersion` to `CDG::Services.get_android_version` to follow ruby naming conventions
+
+## [0.0.1] - 2017-07-06
+### Added
+- Add method (`CDG::Services.GetIOSVersion`) which fetches the latest ios app's version base on app id via a net/http call
+- Add method (`CDG::Services.GetAndroidVersion`) which fetches the latest android app's version base on an app id via a net/http call

data/README.md

@@ -1,8 +1,12 @@
 # CDG::Services
 
-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/cdg/services`. To experiment with that code, run `bin/console` for an interactive prompt.
+Codigo - Ruby on Rails Team's common services.
 
-TODO: Delete this and the text above, and describe your gem
+We adopted a microservice architecture in devising the approach of usage of this gem.
+
+These services are functions that are expected to be commonly used among our projects.
+
+This library serves to accumulate all this knowledge and speed up development without compromising quality and accuracy.
 
 ## Installation
 
@@ -22,7 +26,24 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Get the latest app version of any iOS app; `app_id` is the id of the app in the form of numerics, eg. `12345678`.
+```ruby
+CDG::Services.get_ios_version(app_id: app_id)
+```
+
+
+Get the latest app version of any Android app; `app_id` is the id of the app in the form of `com.package.name`.
+```ruby
+CDG::Services.get_android_version(app_id: app_id)
+```
+
+
+Send a message to any slack channel via a Slack webhook, eg. `https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX`. See how to set up a [Slack webhook](https://api.slack.com/incoming-webhooks).
+
+Set the webhook in your application's environment variable with the name `SLACK_URL`. This gem access the webhook using `ENV['SLACK_URL']`.
+```ruby
+CDG::Services.get_android_version(app_id: app_id)
+```
 
 ## Development
 

data/lib/cdg/services.rb

@@ -9,7 +9,7 @@ module CDG
 
   module Services
 
-    def self.GetIOSVersion app_id: # eg 123456789
+    def self.get_ios_version app_id: # eg 123456789
       resp = JSON.parse Net::HTTP.get(URI("https://itunes.apple.com/lookup?id=#{app_id}"))
       results = resp["results"]
 
@@ -20,7 +20,7 @@ module CDG
       end
     end
 
-    def self.GetAndroidVersion app_id: # eg sg.codigo.app_name
+    def self.get_android_version app_id: # eg sg.codigo.app_name
       begin
         resp = Nokogiri::HTML(open("https://play.google.com/store/apps/details?id=#{ app_id }&hl=en"))
         elements = resp.css("div[class='content'][itemprop='softwareVersion']")
@@ -33,7 +33,28 @@ module CDG
       rescue OpenURI::HTTPError => e
         return nil
       end
+    end
 
+    def self.ping_slack! webhook: ENV['SLACK_URL'], message:, channel: nil, username: nil
+      begin
+        uri = URI(webhook)
+
+        resp = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+          req = Net::HTTP::Post.new(uri)
+          req['Content-Type'] = 'application/json'
+
+          body = {}
+          body[:text] = message
+          body[:channel] = channel if channel
+          body[:username] = username if username
+          # TODO custom icon_emoji?
+          
+          req.body = body.to_json
+          http.request(req)
+        end
+      rescue => e
+        raise e
+      end
     end
 
   end

data/lib/cdg/services/version.rb

@@ -1,5 +1,5 @@
 module CDG
   module Services
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cdg-services
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Vic-L
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-05 00:00:00.000000000 Z
+date: 2017-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -94,6 +94,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -104,7 +105,6 @@ files:
 - cdg-services.gemspec
 - lib/cdg/services.rb
 - lib/cdg/services/version.rb
-- lib/cdg/version.rb
 homepage: https://github.com/sgcodigo/cdg-services
 licenses:
 - MIT

data/lib/cdg/version.rb

@@ -1,5 +0,0 @@
-module CDG
-  module Services
-    VERSION = "0.0.1"
-  end
-end