minly 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fefd0ca86db32b12699a0a337322b85ddc9fe0d
-  data.tar.gz: e98635c89121f6d6330c8d7d4fa7ef2f2c34a62f
+  metadata.gz: c6d783e1d88bb72bf9f4ce80d327a83868ce60c3
+  data.tar.gz: 917853514de5bb74bfdc3792b3871d781a860c38
 SHA512:
-  metadata.gz: 546c0eb24404aaf49e906647bae88944cf53bffaa5f83bbb46161546bf892ee997952168f738d95ebeb5e30a4a5f04a85326beb959e655d3266a2b1dc5bebccd
-  data.tar.gz: 4ec7413cc8dfbc2f32aacff99e2be9cd7363635a4c8416f9513ecd8e5472ddb1eb24099653bef9af9b99835af16ac1203f6103cbccfe7c08f3c3001620d35892
+  metadata.gz: 5f1f740f7d76e103b5e6d952a6125d3e5d903191aaf6b021159a14a3bb9ba862028c7f9a3194aee547fd54c9f44cc2751987728e4e6d357aefa3ec933755abc0
+  data.tar.gz: ca1e93d4f038f3e5b0a3db08fb38203349761caa3e34f5df18f205c611875ebd7b906a1e98f659babb5c8095d7a5bd426d8b1422b28644a5a99988779439a4ab

data/README.md

@@ -1,28 +1,93 @@
-# Minly
+# Minly-gem [![Code Climate](https://codeclimate.com/github/andela-ooranagwa/minly-gem/badges/gpa.svg)](https://codeclimate.com/github/andela-ooranagwa/minly-gem)
 
-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/minly`. To experiment with that code, run `bin/console` for an interactive prompt.
+Minly-gem provides access to all features of the [_Minly URL shortening service_](http://github.com/andela-ooranagwa/minly) by integrating the Minly API. With the gem, you can effortlessly create and expand minlys; have access to the most popular minlys ever create and also the recent additions to the Minly database. Even features such as deleting, deactivating and editing minlys that are reserved for registered users of the Minly service can also be accessed using a valid token.
 
-TODO: Delete this and the text above, and describe your gem
+## Dependencies
+You need to have Ruby set up on you machine. The gem is built using Ruby version _2.1.7_. Also, you need to have _bundler_ installed (especially if you are including the gem in another app or project).
 
 ## Installation
-
-Add this line to your application's Gemfile:
-
+Add this line to your application's Gemfile
 ```ruby
 gem 'minly'
 ```
+And then execute
+```ruby
+    $ bundle
+```
+Or install it yourself as
+```ruby
+    $ gem install minly
+```
 
-And then execute:
+## Usage
+To starting using minly, you need to require it. Do:
+```ruby
+    $ require 'minly'
+```
+Or add to your code
 
-    $ bundle
+Next you create an instance of the minly gem:
+```ruby
+    $ minly = Minly::Url.new
+```
+Optionally, you can also instantiate with a valid token i.e
+
+```ruby
+    $ minly = Minly::Url.new(_your_valid_token_)
+```
+You can always do:
+```ruby
+$ minly.token #=> to view your token (it returns nil if token is not available)
+$ minly.token = _token_ #=> to set your token
+```
+### Without token
+```ruby
+    # To get the details including the orignal url of a minly:
+    $ minly.expand_minly(_xxx_) #=> (requires a valid minly as argument) returns all the details of the given minly: xxx. Returns an empty hash if the details of the given minly is not found.
+```
+```ruby
+    # To get the most popular minlys
+    $ minly.popular_minlys #=> returns an array containing the five most popular minlys.
+```
+```ruby
+    # To get the recent minlys
+    $ minly.recent_minlys #=> returns an array containing the five recent minlys.
+```
 
-Or install it yourself as:
+### With a _valid_ token
+  In addition to the above methods
+```ruby
+    # To create a customized minly
+    $ minly.create_minly(_original-url_, _vanity-string_) #=> (original-url should be a valid url, vanity-string should be any alphanumeric character(s)) returns details of the created minly.
 
-    $ gem install minly
+```
+```ruby
+    # To change the url target of a minly
+    $ minly.change_minly_target(_xxx_, _new-origin_) #=> (xxx is a valid minly, new-origin is the new origin to assign to xxx) returns the updated minly information
+```
+```ruby
+    # To deactivate or activate a minly
+    $ minly.change_minly_status(_xxx_, _new-status_) #=> (xxx is a valid minly, new-status is the status (true or false) to assign to xxx) returns the updated minly information
+```
+```ruby
+    # To change minly target and status at once
+    $ minly.update_minly (_xxx_, _new-origin_, _new-status_) #=> (xxx is a valid minly, new-origin is the new origin to assign to xxx, new-status is the status (true or false) to assign to xxx)
+```
+```ruby
+    # To delete a minly
+    $ minly.destroy_minly(_xxx_) #=> (xxx is a valid minly) returns the information of the deleted minly
+```
 
-## Usage
+The response of every Minly request is parsed into two: _request status_ and _request response_
 
-TODO: Write usage instructions here
+```ruby
+    $ minly.status #=> [request-type, request-info]
+    $ minly.status["type"] #=> success or error
+    $ minly.status["info"] #=> more information about the request
+```
+```ruby
+    $ minly.response #=> response of the api call
+```
 
 ## Development
 
@@ -32,10 +97,9 @@ 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]/minly. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/andela-ooranagwa/minly. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.1.7

data/lib/minly/url.rb

@@ -7,72 +7,78 @@ API_SHOW_ACTION = API_URL + "api/v1/requests/show/"
 module Minly
   class Url
     attr_accessor :token
-    attr_reader :status, :response
+    attr_reader :status, :response, :connection
 
     def initialize(token = nil)
       @connection = Faraday.new(:url => API_URL)
       @token = token
     end
 
-    def expand(url)
+    def expand_minly(url)
       make_get_request(API_SHOW_ACTION + "expand/" + url)
     end
 
-    def popular_urls
+    def popular_minlys
       make_get_request(API_SHOW_ACTION + "popular/")
     end
 
-    def recent_urls
+    def recent_minlys
       make_get_request(API_SHOW_ACTION + "recent/")
     end
 
-    def shorten_url(url, vanity_string = '')
-      return false if has_no_token_error && !vanity_string.empty?
+    def create_minly(url, vanity_string = '')
+      return false if (vanity_string.nil? || (!vanity_string.empty? && has_no_token_error) )
       @token ||= 0
       params = {
         "url[shortened]" => vanity_string,
         "url[original]" => url,
         "user_token" => token
       }
-      process_resonse @connection.post("/urls.json", params)
+      process_response connection.post("/urls.json", params)
       # user_token=vBIPTJtcHX7cORPGjFXOLvIzKU9hmHX05FST_t-sY6s
     end
 
-    def change_url_target(url, target)
+    def change_minly_target(url, target)
       return false if has_no_token_error
       params = {
         "url[original]" => target,
         user_token: token
       }
-      process_resonse @connection.put("/urls/#{url}.json", params)
+      process_response connection.put("/urls/#{url}.json", params)
     end
 
-    def change_url_status(url, data)
+    def change_minly_status(url, data)
       return false if has_no_token_error
       params = {
         "url[active]" => data,
         user_token: token
       }
-      process_resonse @connection.put("/urls/#{url}.json", params)
+      process_response connection.put("/urls/#{url}.json", params)
     end
 
-    def destroy_url(url)
+    def destroy_minly(url)
       return false if has_no_token_error
       params = {
         user_token: token
       }
-      process_resonse @connection.delete("/urls/#{url}", params)
+      process_response connection.delete("/urls/#{url}.json", params)
     end
 
-    def update_url(url, origin="", active="")
-      return false if has_no_token_error
+    def update_minly(url, origin, active)
+      return false if (has_no_token_error || !origin || origin.empty? || active.nil?)
+      params = {
+        "url[active]" => active,
+        "url[orignal]" => origin,
+        user_token: token
+      }
+      process_response connection.put("/urls/#{url}.json", params)
     end
 
     def make_get_request(request)
-      process_resonse(@connection.get(request))
+      process_response(connection.get(request))
     end
 
-    def process_resonse(response)
+    def process_response(response)
       response = JSON.parse(response.body)
       @status = parse_status(response)
       @response = response["payload"]
@@ -80,7 +86,7 @@ module Minly
 
     def has_no_token_error
       if !token || token == 0
-        @status = {type: "Error", info: "Request requires a valid user token."}
+        @status = {type: "error", info: "Request requires a valid user token."}
         return true
       end
       false

data/lib/minly/version.rb

@@ -1,3 +1,3 @@
 module Minly
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/minly.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Minly::VERSION
   spec.authors       = ["Osmond Oscar"]
   spec.email         = ["oskarromero3@gmail.com"]
-
+  spec.description   = %q[Minly-gem provides access to all features of the Minly URL shortening service by integrating the Minly API. With the gem, you can effortlessly create and expand minlys; have access to the most popular minlys ever create and also the recent additions to the Minly database. Even features such as deleting, deactivating and editing minlys that are reserved for registered users of the Minly service can also be accessed using a valid token.]
   spec.summary       = %q{Gem to wrap minly url shortener api}
   spec.homepage      = "http://github.com/andela-ooranagwa/minly/"
   spec.license       = "MIT"
@@ -23,6 +23,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest",  "~> 5.8", ">= 5.8.0"
   spec.add_development_dependency "vcr", "~> 2.9", ">= 2.9.3"
   spec.add_development_dependency "webmock", "~> 1.22", ">= 1.22.1"
+  spec.add_development_dependency "simplecov", "~> 0.10.0"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4.8"
+  spec.add_development_dependency "pry", "~>0.10.3"
 
   spec.add_dependency "faraday", "~> 0.9", ">= 0.9.2"
   spec.add_dependency "json", "~> 1.8", ">= 1.8.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minly
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Osmond Oscar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2015-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,6 +98,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.22.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -138,7 +180,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.3
-description: 
+description: Minly-gem provides access to all features of the Minly URL shortening
+  service by integrating the Minly API. With the gem, you can effortlessly create
+  and expand minlys; have access to the most popular minlys ever create and also the
+  recent additions to the Minly database. Even features such as deleting, deactivating
+  and editing minlys that are reserved for registered users of the Minly service can
+  also be accessed using a valid token.
 email:
 - oskarromero3@gmail.com
 executables: []
@@ -154,10 +201,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- circle.yml
 - lib/minly.rb
 - lib/minly/url.rb
 - lib/minly/version.rb
-- minly-0.1.0.gem
 - minly.gemspec
 homepage: http://github.com/andela-ooranagwa/minly/
 licenses: