sec_edgar_ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0b5a4e4ec058dc727c6b18bc7693f648cbf425a5ec130340bca25d03d2c14e2
-  data.tar.gz: 4b20aa4496d85625dc7194f63390525e8689bf65c8621fbf442b9cf49919dc66
+  metadata.gz: c9bb05fa37127b8e9c21af85244ada60b40e2ea6f036a98e13374a5a1a11eb67
+  data.tar.gz: 14fa10c980fcb19b429b4c42cf7c4a3b1e2cd53220bdf8d14e23ff361f6cd9a6
 SHA512:
-  metadata.gz: dca2272de71d15421010d9f1e970221b3d4b01eb8d89d959236f02fee8eb121df5ce3ccd9eec87db207ed8c5febe94ca5e135ce57ea30e0a75924fab6469f91a
-  data.tar.gz: 6f97e6427e909b4181377f6bcae59dc5629ce6f1fd979a5ed3b4090fd33dc14ae9f56062d99a95423a0f3b1f58e4d8fe752451c39b909b9cd087196b1dc0d1ef
+  metadata.gz: cec0c903191272ac79836f656f9563c92105072960bdc5013b4fc81dacc96fa0eef8847a7876ed2cf33e46af1b016c190c68e19bffde5864125fd5ab6e040ba5
+  data.tar.gz: 5bf3d916dbbcb775c1295c9197555f7375def795591a92b14befad258ebb74f277d34e74df92d5fe531b1d9fd9d21e6552b7e48a7d65f70405ddff2ca3f4a7b4

data/CHANGELOG.md

@@ -7,3 +7,9 @@
 ## [0.1.1] - 2022-07-20
 
 - Update some small issues.
+
+## [0.1.2] - 2022-07-20
+
+- Update user agent.
+- Handle some responses.
+- Retry 3 times for some cases.

data/README.md

@@ -31,3 +31,11 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the SecEdgarRuby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nnhansg/sec-edgar-ruby/blob/master/CODE_OF_CONDUCT.md).
+
+## Notes
+
+### Fair Access
+
+To ensure that everyone has equitable access to SEC EDGAR content, please use efficient scripting, downloading only what you need and please moderate requests to minimize server load. Current guidelines limit each user to a total of no more than 10 requests per second, regardless of the number of machines used to submit requests.
+
+To ensure that SEC.gov remains available to all users, we reserve the right to block IP addresses that submit excessive requests. The SEC does not allow "unclassified" bots or automated tools to crawl the site. Any request that has been identified as part of an unclassified bot or an automated tool outside of the acceptable policy will be managed to ensure fair access for all users. See the Developer FAQ on how to comply with SEC's Web Site Privacy and Security Policy.

data/lib/sec_edgar_ruby/submission.rb

@@ -9,24 +9,54 @@ module SecEdgarRuby
       "https://data.sec.gov/submissions/CIK#{cik}.json"
     end
 
-    # @options: { cik: 'xxx' }
+    # @options: { cik: 'xxx', user_agent: 'Name (email)', attempts: 0 }
     def self.find(options = {})
       result = {}
+      options[:user_agent] ||= "#{SecEdgarRuby.name}/#{SecEdgarRuby::VERSION}"
+      options[:attempts] = options[:attempts].to_i
       return result if options.blank? || options[:cik].blank?
 
       url = cik_api_url(options[:cik])
       return result if url.blank?
 
+      puts "GET: #{url}"
+
       response = Faraday.get(url) do |request|
         request.headers['Accept'] = '*/*'
         request.headers['Content-Type'] = 'application/json'
-        request.headers['User-Agent'] = "#{SecEdgarRuby.name}/#{SecEdgarRuby::VERSION}"
+        request.headers['User-Agent'] = options[:user_agent]
+      end
+
+      content_type = response.headers['content-type']
+      puts "Headers: #{response.headers}"
+
+      case content_type
+      when 'application/json'
+        result = JSON.parse(response.body)
+      when 'application/xml'
+        result = Hash.from_xml(response.body).as_json
+      when 'text/html'
+        options[:attempts] = options[:attempts].to_i + 1
+        return find(options) if options[:attempts].to_i > 2
+
+        result = {
+          error: {
+            message: 'Your Request reached to limit or is rejected.',
+            details: response.body
+          }
+        }
+      else
+        options[:attempts] = options[:attempts].to_i + 1
+        return find(options) if options[:attempts].to_i > 2
+
+        result = {
+          error: {
+            message: 'Your Request is unknown or rejected.',
+            details: response.body
+          }
+        }
       end
 
-      result = JSON.parse(response.body)
-      Util.deep_snake_case_keys(result)
-    rescue JSON::ParserError => e
-      result = Hash.from_xml(response.body).as_json
       Util.deep_snake_case_keys(result)
     end
   end

data/lib/sec_edgar_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SecEdgarRuby
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sec_edgar_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nhan Nguyen
@@ -86,8 +86,8 @@ files:
 - lib/sec_edgar_ruby/submission.rb
 - lib/sec_edgar_ruby/util.rb
 - lib/sec_edgar_ruby/version.rb
+- pkg/sec_edgar_ruby-0.1.1.gem
 - sec_edgar_ruby.gemspec
-- sig/sec_edgar_ruby.rbs
 - spec/sec_edgar_ruby_spec.rb
 - spec/spec_helper.rb
 homepage: http://www.nhansg.com

data/sig/sec_edgar_ruby.rbs

@@ -1,4 +0,0 @@
-module SecEdgarRuby
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end