osm 1.3.5 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0177d47e98ea656ecdad719a55a0273b781625009e4f0b0942da6c94caca4cf9
-  data.tar.gz: b521865ef394bd2fe8f2eeafa47bec0bc832963ee9efdc4d1d536415511736a6
+  metadata.gz: de944e799944f2224443c581abf8055e0de057e711f16e0d5caaab6a3112e055
+  data.tar.gz: 641523cb53513ba158f46ee9f451c616b425853217daae3d3232255f1debd50a
 SHA512:
-  metadata.gz: 1b7347f4a4d8aad58dc722e69ac2036d6c9905c55288d08dc1249bc53d399724cfb55637c38d6520a8d145b47a56daf7634b7d672e090159bac0d6b69f8ce296
-  data.tar.gz: e840bff977c97318ca8c88e106e048ab6eb44daeabc94aacecfadedb96790b9d570a121cd0af521ddb233d9c78ed59305417b8616bdcd0f7353ae8a3f6c837db
+  metadata.gz: 01e7e3484bb55078609f242e8c5d4382bf7af025b7160f7b31d33ad8ced0545bb07b591f2991808ae6a5c03527b976598a863a68738fc0fb91b57a996511b030
+  data.tar.gz: 7b6f1071a85cd1bf688841a0eec8e9f4abe2e64b770f54f4e32af3b498cc5788899ca169ce076b9274679a5fe0141a12ee1a16a5cf28c3f7dac251d1ff762fa2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Version 1.3.6
+
+  * OSM gem is no longer supported. See UNSUPPORTED.md for more details.
+
 ## Version 1.3.5
 
   * Fix to fetching members - not correctly interpreting enabledness of phone numbers and emails.

data/README.md

@@ -1,3 +1,6 @@
+# UNSUPPORTED!
+**This gem is no longer supported, see [UNSUPPORTED.md](UNSUPPORTED.md).**
+
 [![Gem Version](https://badge.fury.io/rb/osm.png)](http://badge.fury.io/rb/osm)
 
 Master branch:
@@ -11,7 +14,7 @@ Staging branch:
 [![Code Climate](https://codeclimate.com/github/robertgauld/osm.png?branch=staging)](https://codeclimate.com/github/robertgauld/osm)
 
 
-##Build State
+## Build State
 This project uses continuous integration to help ensure that a quality product is delivered.
 Travis CI monitors two branches (versions) of the code - Master (which is what gets released)
 and Staging (which is what is currently being developed ready for moving to master).

data/UNSUPPORTED.md

@@ -0,0 +1,22 @@
+# OSM GEM WILL BE UNSUPPORTED AFTER 4th NOVEMBER 2019
+
+After much annoyance at seeing how society is still insisting that STEM is not girly and consequences that has
+on Brownie aged girls I’ve decided to do something about it. In order to get the time I need I’m leaving Scouting
+(after almost 20 years so whilst this is a positive decision for me it is still big enough that I’ve not taken it
+lightly). Since that means I will no longer be routinely using OSM or legitimately having access to any live
+sections in OSM I feel that future development/maintenance of OSM Extender is not something that I can in good
+conscious continue to commit to.
+
+In the absence of anyone coming forward to pick up the baton, in which case I'll update you again by updating
+this file and requiring you to change the value of the :i_know argument passed when configuring the API class.
+
+OSM gem will be available but unsupported after the 4th of November 2019.
+
+You will be required to acknowledge this message by adding **i_know: :unsupported** to either:
+  * the arguments passed to Osm::Api.configure
+  * the hash passed as the :api argument to Osm.configure
+
+# OSM Gem will only receive urgent security/bug fixes until then!
+
+If a security issue arises before then it will be fixed and a new version pushed as normal.
+However only important bugs will be fixed.

data/lib/osm/api.rb

@@ -31,14 +31,21 @@ module Osm
     # @option options [Boolean] :debug if true debugging info is output (optional, default = false)
     # @return nil
     def self.configure(options)
+      unless options[:i_know].eql?(:unsupported)
+        raise Osm::Error, 'The OSM gem is now unsupported. ' \
+                          'To continue using it append "i_know: :unsupported" to your passed options. ' \
+                          "See #{File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'UNSUPPORTED.md'))} for more details."
+      end
+
       raise ArgumentError, ':default_site does not exist in options hash or is invalid, this should be set to either :osm or :ogm' unless Osm::Api::BASE_URLS.keys.include?(options[:default_site])
       raise ArgumentError, ":#{options[:default_site]} does not exist in options hash" if options[options[:default_site]].nil?
+
       Osm::Api::BASE_URLS.keys.each do |api_key|
         if options[api_key]
           api_data = options[api_key]
           raise ArgumentError, ":#{api_key} must be a Hash" unless api_data.is_a?(Hash)
           [:id, :token, :name].each do |key|
-            raise ArgumentError, ":#{api_key} must contain a key :#{key}" if api_data[key].nil?
+            raise ArgumentError, ":#{api_key} must contain a key :#{key}" unless api_data.key?(key)
           end
         end
       end

data/spec/osm/api_spec.rb

@@ -10,6 +10,11 @@ describe "API" do
     @api.api_name.should == @CONFIGURATION[:api][:osm][:name]
   end
 
+  it "Raises errors on trying to configure if abandonment is not acknowledged" do
+    expect { Osm::Api.configure default_site: :osm, osm: { id: nil, token: nil, name: nil } }
+      .to raise_error Osm::Error, /^The OSM gem is now unsupported. To continue using it append "i_know: :unsupported" to your passed options. See .+ for more details.$/
+  end
+
   it "Raises errors on bad arguments to configure" do
     expect{ Osm::Api.configure(@CONFIGURATION[:api].select{ |k,v| (k != :default_site)}) }.to raise_error(ArgumentError, ':default_site does not exist in options hash or is invalid, this should be set to either :osm or :ogm')
     expect{ Osm::Api.configure(@CONFIGURATION[:api].merge(:default_site => :invalid)) }.to raise_error(ArgumentError, ':default_site does not exist in options hash or is invalid, this should be set to either :osm or :ogm')

data/spec/spec_helper.rb

@@ -57,13 +57,14 @@ RSpec.configure do |config|
           :token => 'API TOKEN 2',
           :name => 'API NAME 2',
         },
+        :i_know => :unsupported
       },
       :cache => {
         :cache => OsmTest::Cache,
       },
     }
     Osm::configure(@CONFIGURATION)
-    
+
     @api = Osm::Api.new('user_id', 'secret')
     Osm::Model.stub(:require_ability_to).and_return(nil)
     Osm::Model.stub(:require_access_to_section).and_return(nil)

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = '1.3.5'
-end
+  VERSION = '1.3.6'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.6
 platform: ruby
 authors:
 - Robert Gauld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-28 00:00:00.000000000 Z
+date: 2019-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -233,6 +233,7 @@ files:
 - LICENSE.rdoc
 - README.md
 - Rakefile
+- UNSUPPORTED.md
 - gemfiles/rails3
 - gemfiles/rails4
 - gemfiles/rails5