wor-requests 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ab5a51f2877974f836e6c6275f03a461c3b4f707
-  data.tar.gz: b06bac7b122ee50d17a3232f99b250000850320f
+SHA256:
+  metadata.gz: f9b90d0e2c2d7625668dd56b8b5ca6fd2bb1be90a95f64dab63351ae68f34f39
+  data.tar.gz: 18ad91e482c4308f8867a41b87422f3de9711996a385121fbe13a5c300404f50
 SHA512:
-  metadata.gz: 2c1ea9a833e798677bc1314f5131408fe24a599fdfb353d34c53bf77366ddada243e74ec54e76fb55129fbebc404064b185ad542b81c663d216321c19b2a4c16
-  data.tar.gz: 9e0f623dec18850fdb63fafaa732930f0dae07b3ccdec2d9fe81d6097b21468f41867e6b4778bb613ee43b213f073f06457b1b118dee17a0ec7369c3cd1f9944
+  metadata.gz: c91be95c5797371e4f9c96b0f0d18a935df24cafacf81e14a4c039daca2204cdca4f3525d216c9dd90fa2c2f60e1c4a63d66165505ff744410d39cc58fad4a9e
+  data.tar.gz: ca4426836c9832f24ead8f3091c5cb073a5de770e89cd431064ff108bc889da3fc347ee8ef542e0b770b4f33998acb2163e044a1c2402260fd9cfaa2175d1818

data/.travis.yml

@@ -1,14 +1,15 @@
 language: ruby
 rvm:
-  - 2.2.2
-  - 2.3.3
-  - 2.4.0
+  - 2.3.8
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 
-install:
+before_install:
+  - gem update --system
   - gem install bundler
-  - bundle install --retry=3
 
 script:
+  - bundle exec rubocop lib spec -R --format simple
   - bundle exec rspec
-  - bundle exec rubocop -R --format simple
   - bundle exec codeclimate-test-reporter

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 
 ## Change log
 
+### V0.1.2
+* [#42](https://github.com/Wolox/wor-requests/pull/42): Service generator - [@blacksam07](https://github.com/blacksam07).
+* [#41](https://github.com/Wolox/wor-requests/pull/41): Add validation when base_url method is empty - [@blacksam07](https://github.com/blacksam07).
+* [#39](https://github.com/Wolox/wor-requests/pull/39): Handling the case when response body is empty - [@mnmallea](https://github.com/mnmallea).
+
+### V0.1.1
+* [#35](https://github.com/Wolox/wor-requests/pull/35): updated version - [@hdf1986](https://github.com/hdf1986).
+
 ### [0.1.0]
 
 #### Added

data/README.md

@@ -1,9 +1,7 @@
 # Wolox on Rails - Requests
 [![Gem Version](https://badge.fury.io/rb/wor-requests.svg)](https://badge.fury.io/rb/wor-requests)
-[![Dependency Status](https://gemnasium.com/badges/github.com/Wolox/wor-requests.svg)](https://gemnasium.com/github.com/Wolox/wor-requests)
 [![Build Status](https://travis-ci.org/Wolox/wor-requests.svg)](https://travis-ci.org/Wolox/wor-requests)
 [![Code Climate](https://codeclimate.com/github/Wolox/wor-requests/badges/gpa.svg)](https://codeclimate.com/github/Wolox/wor-requests)
-[![Test Coverage](https://codeclimate.com/github/Wolox/wor-requests/badges/coverage.svg)](https://codeclimate.com/github/Wolox/wor-requests/coverage)
 
 Make external requests in you service objects, with easy logging and error handling!
 
@@ -33,8 +31,29 @@ Wor::Requests.configure do |config|
 end
 ```
 
-## Usage
+## Generators
+```ruby
+rails generate wor:requests:service NAME
+```
+
+### Generator options
+#### module
+Specifying the module name as:
+
+```ruby
+rails generate wor:requests:service NAME --module MODULE_NAME
+```
+We can create a service with an inner class called NAME, and external module called MODULE_NAME
 
+```ruby
+module ModuleName
+  class NameService < Wor::Requests::Base
+    # Your code here
+  end
+end
+```
+
+## Service example
 To write your first Service using Wor-requests you can write something like this:
 
 ```ruby
@@ -57,12 +76,9 @@ class GithubService < Wor::Requests::Base
   end
 end
 
-puts GithubService.new.repositories('alebian')
+puts GithubService.new.repositories('wolox')
 ```
 
-Or, even easier, run `rails generate wor:requests:service NAME` in your Rails root
-
-
 If you need to send body parameters in a post request you can write something like this:
 
 ```ruby
@@ -104,8 +120,12 @@ ExternalService.new.post_request_example(token)
 7. Create a new Pull Request
 
 ## About ##
+This project was developed by [Diego Raffo](https://github.com/enanodr) along with [Michel Agopian](https://github.com/mishuagopian) and it was written by [Wolox](http://www.wolox.com.ar).
+
+Maintainers: [Samir Tapiero](https://github.com/blacksam07)
+
+Contributors: [Diego Raffo](https://github.com/enanodr) [Michel Agopian](https://github.com/mishuagopian)
 
-This project is maintained by [Diego Raffo](https://github.com/enanodr) along with [Michel Agopian](https://github.com/mishuagopian) and it was written by [Wolox](http://www.wolox.com.ar).
 ![Wolox](https://raw.githubusercontent.com/Wolox/press-kit/master/logos/logo_banner.png)
 
 ## License

data/lib/generators/templates/base_service.rb.erb

@@ -1,3 +1,24 @@
+<% if @module_name.present? %>
+module <%= @module_name.camelize %>
+  class <%= class_name %>Service < Wor::Requests::Base
+    # An example of how to get all repositories for the specified user in github.com
+    # def repositories(username)
+    #   get(
+    #     attempting_to: "get repositories of #{username}",
+    #     path: "/users/#{username}/repos"
+    #   )
+    # rescue Wor::Requests::RequestError => e
+    #   puts e.message
+    # end
+
+    # protected
+
+    # def base_url
+    #   'https://api.github.com'
+    # end
+  end
+end
+<% else %>
 class <%= class_name %>Service < Wor::Requests::Base
   # An example of how to get all repositories for the specified user in github.com
   # def repositories(username)
@@ -15,3 +36,4 @@ class <%= class_name %>Service < Wor::Requests::Base
   #   'https://api.github.com'
   # end
 end
+<% end %>

data/lib/generators/wor/requests/service_generator.rb

@@ -2,11 +2,22 @@ module Wor
   module Requests
     module Generators
       class ServiceGenerator < Rails::Generators::NamedBase
+        SERVICE_DIR_PATH = 'app/services'.freeze
         source_root File.expand_path('../../../templates', __FILE__)
         desc 'Creates Wor-requests service for your application'
 
+        class_option :module, type: :string
+
         def create_service
-          template 'base_service.rb.erb', "app/services/#{plural_name}_service.rb"
+          @module_name = options[:module]
+
+          generator_dir_path = "#{SERVICE_DIR_PATH}
+            #{("/#{@module_name.underscore}" if @module_name.present?)}"
+          generator_path = "#{generator_dir_path}/#{file_name}_service.rb"
+
+          FileUtils.mkdir_p(generator_dir_path) unless File.exist?(generator_dir_path)
+
+          template 'base_service.rb.erb', generator_path
         end
       end
     end

data/lib/wor/requests.rb

@@ -1,5 +1,6 @@
 require_relative 'requests/base'
 require_relative 'requests/request_error'
+require_relative 'requests/malformed_base_url'
 require_relative 'requests/version'
 require 'logger'
 
@@ -22,6 +23,7 @@ module Wor
 
     def self.default_response_type=(type)
       return unless VALID_RESPONSE_TYPES.include?(type)
+
       @config[:default_response_type] = type
     end
 

data/lib/wor/requests/base.rb

@@ -45,6 +45,7 @@ module Wor
         resp = HTTParty.send(options[:method], uri(options[:path]), request_parameters(options))
 
         return after_success(resp, options, &block) if resp.success?
+
         after_error(resp, options)
       end
 
@@ -72,6 +73,7 @@ module Wor
         log_success(options[:attempting_to])
 
         return yield(response) if block_given?
+
         handle_response(response, options[:response_type])
       end
 
@@ -85,35 +87,39 @@ module Wor
       end
 
       def formatted_base_url
+        raise MalformedBaseUrl if base_url.nil?
+
         base_url[-1] != '/' ? "#{base_url}/" : base_url
       end
 
       def formatted_path(path)
         return '' if path.nil?
         return path if path[0] != '/'
+
         path.slice!(0)
         path
       end
 
       def log_success(attempt)
         return unless present?(attempt)
+
         logger.info "SUCCESS: #{attempt}"
       end
 
       def log_attempt(attempt)
         return unless present?(attempt)
+
         logger.info "ATTEMPTING TO: #{attempt}"
       end
 
       def log_error(response, attempting_to)
         return unless present?(attempting_to)
+
         response_error = "ERROR when trying to #{attempting_to}. "
         response_error << "Got status code: #{response.code}. "
-        if present?(response.body)
-          response_error << "Response error: #{JSON.parse(response.body)}"
-        end
+        response_error << "Response error: #{JSON.parse(response.body)}" if present?(response.body)
         logger.error response_error
-      rescue => e
+      rescue JSON::ParserError => e
         logger.error("#{response_error} ERROR while parsing response body: #{e.message}.")
       end
 
@@ -139,18 +145,20 @@ module Wor
 
       def validate_method!(method)
         return true if VALID_HTTP_VERBS.include?(method)
+
         raise ArgumentError, "#{method} is not a valid method."
       end
 
       def response_type(type)
         return type if Wor::Requests::VALID_RESPONSE_TYPES.include?(type)
+
         default_response_type
       end
 
       def handle_response(response, response_type)
         case response_type(response_type)
         when :json
-          JSON.parse(response.body)
+          JSON.parse(response.body) if response.body.present?
         else
           response.body
         end

data/lib/wor/requests/malformed_base_url.rb

@@ -0,0 +1,9 @@
+module Wor
+  module Requests
+    class MalformedBaseUrl < StandardError
+      def initialize(msg = 'The method base_url is malformed')
+        super(msg)
+      end
+    end
+  end
+end

data/lib/wor/requests/version.rb

@@ -1,5 +1,5 @@
 module Wor
   module Requests
-    VERSION = '0.1.1'.freeze
+    VERSION = '0.1.2'.freeze
   end
 end

data/wor-requests.gemspec

@@ -22,13 +22,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'httparty', '~> 0.13'
-  spec.add_dependency 'railties', '>= 4.1.0', '< 5.2'
+  spec.add_dependency 'railties', '>= 4.1.0', '<= 6.0.0'
 
   spec.add_development_dependency 'faker'
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'byebug', '~> 9.0'
   spec.add_development_dependency 'rubocop', '~> 0.47.0'
-  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wor-requests
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - draffo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-16 00:00:00.000000000 Z
+date: 2019-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -32,9 +32,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,9 +42,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -107,14 +107,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -210,6 +210,7 @@ files:
 - lib/wor/requests.rb
 - lib/wor/requests/base.rb
 - lib/wor/requests/invalid_options_error.rb
+- lib/wor/requests/malformed_base_url.rb
 - lib/wor/requests/request_error.rb
 - lib/wor/requests/version.rb
 - wor-requests.gemspec
@@ -232,8 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Make external requests in you service objects, with easy logging and error