salesforce_http_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ced76573a38601c160a91e585daac06094c6a1f7
+  data.tar.gz: d140a7815470645577a4bc8310f4e02af941ea00
+SHA512:
+  metadata.gz: 778cf8fde5dca1f7af4ad9951f8c8e22096fb7957c95fe43f13ccd33b8a476788d9e6c68755a9b52cf61c8c03c883ba67d478557bed82a396fc0b505e2441a62
+  data.tar.gz: a0d21e3f8e1adbcd3ee4e02848e117d3484ef160f2687dc32a73a63110a82a08ab978f5633dfb32e3e0f8dbc151270205c407fe3f3e89220d52901b75f549923

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  Include:
+    - lib/**/*.rb
+    - spec/**/*.rb
+Documentation:
+  Enabled: false
+StringLiterals:
+  Enabled: false
+LineLength:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in salesforce-http-client.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+group :dev, halt_on_fail: true do
+  guard :rspec, all_on_start: false, all_after_pass: false, failed_mode: :keep, cmd: 'bundle exec rspec' do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')                        { 'spec' }
+    watch(%r{^spec/support/(.+)\.rb$})                  { 'spec' }
+  end
+
+  guard :rubocop, all_on_start: false, all_after_pass: false do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end
+
+# default group
+scope group: :dev

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kun Wang
+
+MIT License
+
+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

@@ -0,0 +1,29 @@
+# SalesforceHttpClient
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'salesforce_http_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install salesforce_http_client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/salesforce_http_client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/salesforce_http_client.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/**/*.rb"].sort.each do |path|
+  require path
+end

data/lib/salesforce_http_client/client.rb

@@ -0,0 +1,42 @@
+require 'salesforce_http_client/salesforce_http_access'
+
+module SalesforceHttpClient
+  class Client
+    include SalesforceHttpAccess
+
+    attr_accessor :config
+    attr_accessor :logger
+
+    def initialize
+      @config = Configuration.new
+      @logger = config.logger
+    end
+
+    def download_report(report_id, output_save_path, override_if_exists = false)
+      return if check_override_ng(output_save_path, override_if_exists)
+      download_from_salesforce(output_save_path, report_id)
+    end
+
+    private
+
+    def check_override_ng(output_save_path, override_if_exists)
+      if !override_if_exists && File.exist?(output_save_path)
+        @logger.error "file exists: #{output_save_path}"
+        true
+      else
+        delete_exist_file(output_save_path)
+        false
+      end
+    end
+
+    def delete_exist_file(output_save_path)
+      return unless File.exist?(output_save_path)
+      File.delete(output_save_path)
+      @logger.info "exist file deleted: #{output_save_path}"
+    end
+
+    def report_url(report_id)
+      @config.report_url(report_id)
+    end
+  end
+end

data/lib/salesforce_http_client/configuration.rb

@@ -0,0 +1,42 @@
+require 'logger'
+
+module SalesforceHttpClient
+  class Configuration
+    attr_accessor :salesforce_login_url
+    attr_accessor :salesforce_logout_url
+
+    attr_accessor :salesforce_login_id
+    attr_accessor :salesforce_password
+
+    attr_accessor :salesforce_report_url_format
+    attr_accessor :salesforce_report_id_param
+
+    attr_accessor :http_timeout
+    attr_accessor :tmp_dir
+
+    attr_accessor :logger
+    attr_accessor :log_level
+
+    def initialize
+      @salesforce_login_url = "https://login.salesforce.com/"
+      @salesforce_logout_url = "https://ap.salesforce.com/secur/logout.jsp"
+
+      @salesforce_report_url_format = 'https://ap.salesforce.com/#{report_id}?export=1&enc=UTF-8&xf=csv'
+      @salesforce_report_id_param = '#{report_id}'
+
+      @http_timeout = 5 * 60 * 1000
+      @tmp_dir = './tmp'
+
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::WARN
+    end
+
+    def report_url(report_id)
+      @salesforce_report_url_format.gsub(@salesforce_report_id_param, report_id)
+    end
+
+    def cookie_store_file_path
+      File.join(@tmp_dir, 'cookie_store.dat')
+    end
+  end
+end

data/lib/salesforce_http_client/salesforce_http_access.rb

@@ -0,0 +1,53 @@
+module SalesforceHttpClient
+  module SalesforceHttpAccess
+    attr_accessor :http_client
+
+    def download_from_salesforce(output_save_path, report_id)
+      create_http_client
+      salesforce_login
+      download_and_save_report(report_id, output_save_path)
+      salesforce_logout
+    end
+
+    def create_http_client
+      @http_client = HTTPClient.new
+      @http_client.receive_timeout = @config.http_timeout
+      @http_client.set_cookie_store(@config.cookie_store_file_path)
+      @http_client
+    end
+
+    def salesforce_login
+      @logger.info "try salesforce login..."
+      @http_client.get config.salesforce_login_url
+      body = { 'un' => @config.salesforce_login_id, 'pw' => @config.salesforce_password }
+      response = @http_client.post(config.salesforce_login_url, body)
+      respond_to_redirect(response)
+    end
+
+    def respond_to_redirect(response)
+      while response.status == 302 && response.headers['Location'] && !response.headers['Location'].empty?
+        @logger.info "redirect to #{response.headers['Location']}"
+        response = @http_client.get(response.headers['Location'])
+      end
+    end
+
+    def download_and_save_report(report_id, output_save_path)
+      @logger.info "begin download reports"
+      response = @http_client.get report_url(report_id)
+      if response.status == 200
+        report_content = response.content
+        report_file = output_save_path
+        @logger.info "save result to file #{report_file}"
+        File.write(report_file, report_content)
+      else
+        @logger.error "failed to download reports."
+      end
+    end
+
+    def salesforce_logout
+      @logger.info "try salesforce logout..."
+      @http_client.get config.salesforce_logout_url
+      @logger.info "salesforce logged out."
+    end
+  end
+end

data/lib/salesforce_http_client/version.rb

@@ -0,0 +1,3 @@
+module SalesforceHttpClient
+  VERSION = "0.0.1"
+end

data/salesforce_http_client.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'salesforce_http_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "salesforce_http_client"
+  spec.version       = SalesforceHttpClient::VERSION
+  spec.authors       = ["Apuruni"]
+  spec.email         = ["apuruni@gmail.com"]
+  spec.summary       = "a http client for salesforce.com"
+  spec.description   = "allow you to download a report from salesforce.com quickly."
+  spec.homepage      = "https://github.com/apuruni/salesforce_http_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'httpclient', '~> 2.6.0.1'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-legacy_formatters"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-rubocop"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+end

data/spec/salesforce_http_client/client_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module SalesforceHttpClient
+  describe Client do
+    it 'can be init' do
+      client = SalesforceHttpClient::Client.new
+      expect(client).to_not be_nil
+    end
+  end
+
+  describe '#download_report' do
+    before do
+      stub_request(:get, "https://login.salesforce.com/")
+        .to_return(status: 200, body: "", headers: {})
+
+      stub_request(:post, "https://login.salesforce.com/")
+        .with(body: { "pw" => "", "un" => "" })
+        .to_return(status: 302, body: "", headers: { 'Location' => 'https://ap.salesforce.com/secur/frontdoor.jsp?sid=00D10000000ZIju%21ARkAQBU5ixFxxAzNvQTreC6rOQ9QSt_cMxFbwmVoVNbWtl.xxHasjFO8v100wa6b0kv.c9Q9RzYuwss9F5TodikF.ELZAHwq&apv=1&cshc=0000001shFs0000000ZIju&display=page' })
+
+      stub_request(:get, "https://ap.salesforce.com/secur/frontdoor.jsp?apv=1&cshc=0000001shFs0000000ZIju&display=page&sid=00D10000000ZIju!ARkAQBU5ixFxxAzNvQTreC6rOQ9QSt_cMxFbwmVoVNbWtl.xxHasjFO8v100wa6b0kv.c9Q9RzYuwss9F5TodikF.ELZAHwq")
+        .to_return(status: 200, body: "", headers: {})
+
+      stub_request(:get, "https://ap.salesforce.com/a?enc=UTF-8&export=1&xf=csv")
+        .to_return(status: 200, body: "", headers: {})
+
+      stub_request(:get, "https://ap.salesforce.com/secur/logout.jsp")
+        .to_return(status: 200, body: "", headers: {})
+    end
+
+    it 'can download report' do
+      output_file = "tmp/report_a.csv"
+      File.delete(output_file) if File.exist?(output_file)
+
+      client = SalesforceHttpClient::Client.new
+      client.download_report("a", output_file)
+    end
+  end
+end

data/spec/salesforce_http_client/configuration_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+module SalesforceHttpClient
+  describe Configuration do
+    it 'can be init' do
+      client = SalesforceHttpClient::Configuration.new
+      expect(client).to_not be_nil
+    end
+  end
+end

data/spec/salesforce_http_client/version_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'salesforce_http_client/version'
+
+module SalesforceHttpClient
+  describe 'VERSION' do
+    it 'has a version number' do
+      expect(SalesforceHttpClient::VERSION).not_to be nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'salesforce_http_client'
+
+RSpec.configure do
+  require 'webmock/rspec'
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: salesforce_http_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Apuruni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-legacy_formatters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: allow you to download a report from salesforce.com quickly.
+email:
+- apuruni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/salesforce_http_client.rb
+- lib/salesforce_http_client/client.rb
+- lib/salesforce_http_client/configuration.rb
+- lib/salesforce_http_client/salesforce_http_access.rb
+- lib/salesforce_http_client/version.rb
+- salesforce_http_client.gemspec
+- spec/salesforce_http_client/client_spec.rb
+- spec/salesforce_http_client/configuration_spec.rb
+- spec/salesforce_http_client/version_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/apuruni/salesforce_http_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: a http client for salesforce.com
+test_files:
+- spec/salesforce_http_client/client_spec.rb
+- spec/salesforce_http_client/configuration_spec.rb
+- spec/salesforce_http_client/version_spec.rb
+- spec/spec_helper.rb