soap-response_cutter 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0f969aafc0a1f671abe44b5a3a4aac4fb175980
-  data.tar.gz: e08dfad5c3d6c06a6e568ec0ec842fdca98e9a98
+  metadata.gz: a9b98c0c734e048dc25a4fc0942ec1217d08e1cf
+  data.tar.gz: 11d60da98bda8a15ff67f099b7101e15cfd82cb0
 SHA512:
-  metadata.gz: ea88c32d7ef4bd06e55815af8882cbe67bb255827e2e16dd9975b5c611da5574854458e095b079eacab517e05e6cf31d2727e7e94a58f99edac74e1a0be31258
-  data.tar.gz: f1df64deab2b3e8df4660da58c3aa44afaad4f92f6b60157f301905685bbba187d848f99542edf2486000e0e08dfd5a891ddc52199ca416fe35b4256578a03ac
+  metadata.gz: 64b4a770f68e2f31d0085602c2b781703a2b7c26d40b9cbef2f68023456ed41e2f10acc2376a0aaa3f8150d097f1bda76cc1fc6e263bd422db047f2499ccc636
+  data.tar.gz: 7d620c213e59e9e5daa2422b49e8b320bfeb275ff5589cf2546f89596efd83eda60e132456faf3c72a308ef29567c108e032b67da21835e51e9b90f42ff45aed

data/.gitignore

@@ -1,15 +1,42 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
+*.gem
+*.rbc
+/.config
 /coverage/
-/doc/
+/InstalledFiles
 /pkg/
 /spec/reports/
+/test/tmp/
+/test/version_tmp/
 /tmp/
+/_yardoc/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
 *.bundle
 *.so
 *.o
 *.a
 mkmf.log
 .idea/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Include:
+    - 'Rakefile'
+  Exclude:
+    - spec/**/*

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in shorter-savon-response.gemspec
 gemspec
+
+group :test do
+  gem 'simplecov', require: nil
+  gem 'codeclimate-test-reporter', require: nil
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Mikael Henriksson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -1,13 +1,14 @@
-# Shorter::Savon::Response
+[![Code Climate](https://codeclimate.com/github/mhenrixon/soap-response_cutter/badges/gpa.svg)](https://codeclimate.com/github/mhenrixon/soap-response_cutter) [![Test Coverage](https://codeclimate.com/github/mhenrixon/soap-response_cutter/badges/coverage.svg)](https://codeclimate.com/github/mhenrixon/soap-response_cutter)
+# Soap::ResponseCutter
 
-TODO: Write a gem description
+Gets rid of the `<XmlResponse><XmlResult>` and returns just the stuff you really need
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'shorter-savon-response'
+gem 'soap-response_cutter'
 ```
 
 And then execute:
@@ -16,11 +17,13 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install shorter-savon-response
+    $ gem install soap-response_cutter
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+Soap::ResponseCutter.new(action, response).parse
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,24 @@
-require 'bundler/gem_tasks'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
+Bundler::GemHelper.install_tasks
+
+if defined?(RSpec)
+  namespace :style do
+    desc 'Run Ruby style checks'
+    RuboCop::RakeTask.new(:ruby) do |task|
+      task.patterns = %w(lib/**/*.rb spec/**/*.rb)
+      task.formatters = ['files']
+      task.fail_on_error = true
+    end
+  end
+
+  desc 'Run all style checks'
+  task style: %w(style:ruby)
+
+  desc 'Run all specs in spec directory (excluding plugin specs)'
+  RSpec::Core::RakeTask.new(:spec)
+  task test: :spec
+  task default: %w(style spec)
+end

data/circle.yml

@@ -0,0 +1,9 @@
+machine:
+  timezone:
+      Europe/Stockholm
+  ruby:
+    version: 2.1.5
+
+test:
+  override:
+    - bundle exec rake

data/lib/soap/response_cutter/version.rb

@@ -1,6 +1,6 @@
 module Soap
   # nodoc
   class ResponseCutter
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/lib/soap/response_cutter.rb

@@ -7,6 +7,7 @@ module Soap
   # Examples:
   #   ResponseCutter.new(:soap_action, { somes: 'value'})
   class ResponseCutter
+    USELESS_KEYS = %w(response result return)
     attr_reader :action, :response
 
     def initialize(action, response)
@@ -17,16 +18,8 @@ module Soap
 
     # rubocop:disable MethodLength
     def parse
-      @response = response_part
-
-      return response if response == true
-      return response unless response.is_a?(Hash)
-
-      @response = return_part
-      if response.is_a?(Hash)
-        if (res = return_part)
-          return res
-        end
+      catch :done do
+        flatten_response while useless_nesting?
       end
       response
     end
@@ -34,32 +27,18 @@ module Soap
 
     private
 
-    def response_part
-      response.fetch(response_key) do
-        response.fetch(reverse_response_key, true)
-      end
-    end
-
-    def response_key
-      key('response')
-    end
-
-    def reverse_response_key
-      reverse_key('response')
-    end
-
-    def return_part
-      response.fetch(return_key) do
-        response.fetch(reverse_return_key, true)
+    def flatten_response
+      USELESS_KEYS.each do |suffix|
+        @response = response.fetch(key(suffix)) do
+          response.fetch(reverse_key(suffix)) { response }
+        end
+        throw :done unless response.is_a?(Hash)
+        throw :done unless useless_nesting?
       end
     end
 
-    def return_key
-      key('return')
-    end
-
-    def reverse_return_key
-      reverse_key('return')
+    def useless_nesting?
+      response.any? { |k| k.to_s =~ /response|result|return/ }
     end
 
     def key(suffix)

data/spec/lib/soap/response_cutter_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'soap/response_cutter'
 
 describe Soap::ResponseCutter do
   describe '#parse' do
@@ -25,5 +26,52 @@ describe Soap::ResponseCutter do
       end
       its(:parse) { should eq(expected) }
     end
+
+    context 'nested inverted result' do
+      let(:response) do
+        {
+          abc_response_v2: {
+            abc_return_v2: {
+              abc_return_v2: expected
+            }
+          }
+        }
+      end
+      its(:parse) { should eq(expected) }
+    end
+
+    describe 'real world example' do
+      let(:expected) do
+        {
+          offer_id: '737',
+          game_id: '262',
+          user_id: '1',
+          lines: '1',
+          coins: '20',
+          rounds: '5',
+          denomination: '0.1000',
+          expire_time: 'Sun, 13 Dec 2015 00:00:00 +0000',
+          freegame_external_id: '1',
+          used: nil,
+          turnover: '0',
+          finished: nil,
+          rounds_used: '0',
+          freegame_trigger_id: nil,
+          created: 'Sat, 13 Dec 2014 14:20:11 +0000',
+          currency: nil,
+          '@xmlns:i' => 'http://www.w3.org/2001/XMLSchema-instance'
+        }
+      end
+      let(:response) do
+        {
+          add_freegame_offers_response: {
+            add_freegame_offers_result: expected
+          },
+          :@xmlns => 'http://playngo.com/v1'
+        }
+      end
+      subject { Soap::ResponseCutter.new(:add_freegame_offers, response) }
+      its(:parse) { should eq(expected) }
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'rspec/its'
-require 'soap/response_cutter'
+require_relative 'support/coverage.rb'
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|

data/spec/support/coverage.rb

@@ -0,0 +1,22 @@
+require 'simplecov'
+require 'codeclimate-test-reporter'
+formatters =  [SimpleCov::Formatter::HTMLFormatter]
+
+if ENV['CODECLIMATE_REPO_TOKEN']
+  formatters << CodeClimate::TestReporter::Formatter
+  CodeClimate::TestReporter.start
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[*formatters]
+SimpleCov.profiles.define 'gem' do
+  add_filter '/spec'
+  add_group 'lib', '/lib'
+  add_group 'soap', '/lib/soap'
+end
+
+SimpleCov.start 'gem'
+
+if ENV['CIRCLE_ARTIFACTS']
+  dir = File.join(ENV['CIRCLE_ARTIFACTS'], 'coverage')
+  SimpleCov.coverage_dir(dir)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soap-response_cutter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -103,15 +103,19 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
+- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
+- circle.yml
 - lib/soap/response_cutter.rb
 - lib/soap/response_cutter/version.rb
 - soap-response_cutter.gemspec
 - spec/lib/soap/response_cutter_spec.rb
 - spec/spec_helper.rb
+- spec/support/coverage.rb
 homepage: ''
 licenses:
 - MIT
@@ -139,4 +143,5 @@ summary: Gets rid of <SomethingResponse><SomethingResult> from soap responses
 test_files:
 - spec/lib/soap/response_cutter_spec.rb
 - spec/spec_helper.rb
+- spec/support/coverage.rb
 has_rdoc: