groupme-api 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 570e2a4a593dbf2b1230e6613444e778caa494e9a0c04675632e9b0eafab7ed9
-  data.tar.gz: 2432e495fa8a324c8b6da9edd65d2a8cf2ed7ee315a0561e563fd11981a129be
+SHA1:
+  metadata.gz: ac0f859ba8eaddcf6b9acf212bfef6e20915aab5
+  data.tar.gz: d5c1743b72c49eede05915faf033c9206e7c7e91
 SHA512:
-  metadata.gz: 3fe24ea9b1550413b7f3da932e134bfc45056c436a3068ae1158adf04a3b9b5f0048c9ea5ded585d541c406ea768595fee2375fc10d2d849bd17ef4ea565f108
-  data.tar.gz: 5c7f672ccafb76b8d36ba8f0d880272b35786d5f770e9be9a1897487394e9a0f0a4d9f39274fda11957b6199bbeb3d8e3d542429d065740eb0c24f18194c714f
+  metadata.gz: 9ea0417528eab7af4f850faca868e6fd2d734749b335e326aeca49fdacfe9d8b2a15217c9e71aeb8748654b94b256fc60f660359a2c27f6f9d8902b32360baac
+  data.tar.gz: fbb9f36f96b639106b7a2e818f4be8916941c240555a1b51b2615b5036a08cf7884d11007db686f2206886a8146c0ebcd62404d63946791d6f3be4109b63a2e6

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    groupme-api (0.5.0)
+    groupme-api (0.6.0)
       httpclient (~> 2.8)
 
 GEM

data/groupme-api.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.files        = `git ls-files`.split("\n")
   spec.require_path = 'lib'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
   spec.add_dependency 'httpclient', '~> 2.8'
 

data/lib/groupme.rb

@@ -4,7 +4,13 @@ require 'httpclient'
 require 'json'
 
 require 'groupme/client'
+require 'groupme/configuration'
+require 'groupme/errors'
+require 'groupme/group'
 require 'groupme/version'
 
 module GroupMe
+  def self.reset!
+    @configuration = Configuration.new
+  end
 end

data/lib/groupme/client.rb

@@ -5,13 +5,15 @@ module GroupMe
     API_BASE_URL = 'https://api.groupme.com/v3/'
     API_DEFAULT_HEADER = { 'Content-Type': 'application/json' }.freeze
 
-    def initialize(access_token:)
-      @access_token = access_token
+    attr_accessor :access_token
+
+    def initialize(args = {})
+      @access_token = args[:access_token] || GroupMe.configuration.access_token
       @client = HTTPClient.new(base_url: API_BASE_URL, default_header: API_DEFAULT_HEADER)
     end
 
-    def request(method, path, query: {}, body: {})
-      response = @client.request(method, path, { token: @access_token }.merge(query), body.to_json)
+    def request(method, path, query: {}, body: nil)
+      response = @client.request(method, path, { token: @access_token }.merge(query), body&.to_json)
       [parse_response_body(response), response.status]
     end
 
@@ -35,4 +37,12 @@ module GroupMe
       JSON.parse(response.body, symbolize_names: true).fetch(:response)
     end
   end
+
+  def self.client
+    @client ||= Client.new
+  end
+
+  def self.client=(client)
+    @client = client
+  end
 end

data/lib/groupme/configuration.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module GroupMe
+  class Configuration
+    API_MAX_GROUPS_PER_PAGE = 500
+
+    attr_writer :access_token, :groups_per_page
+
+    def access_token
+      raise MissingConfigurationError unless @access_token
+
+      @access_token
+    end
+
+    def groups_per_page
+      @groups_per_page || API_MAX_GROUPS_PER_PAGE
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(configuration)
+    @configuration = configuration
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/groupme/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GroupMe
+  class MissingConfigurationError < StandardError; end
+end

data/lib/groupme/group.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module GroupMe
+  class Group
+    def self.all
+      GroupMe.client.get('groups', omit: :memberships, per_page: GroupMe.configuration.groups_per_page).first
+    end
+  end
+end

data/lib/groupme/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GroupMe
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/spec/groupme/client_spec.rb

@@ -1,26 +1,36 @@
 # frozen_string_literal: true
 
 RSpec.describe GroupMe::Client do
-  let(:client) { GroupMe::Client.new(access_token: ACCESS_TOKEN) }
-  let(:base_url) { 'https://api.groupme.com/v3/' }
+  include_context :with_default_groupme_configuration
+
+  let(:client) { GroupMe::Client.new(access_token: access_token) }
+  let(:base_url) { GroupMe::Client::API_BASE_URL }
 
   describe '.new' do
-    context 'when :access_token argument is missing' do
-      it 'should raise an error' do
-        expect { GroupMe::Client.new }.to raise_error(ArgumentError)
+    context 'when :access_token is not supplied' do
+      let(:client) { GroupMe::Client.new }
+
+      it 'should use configured :access_token' do
+        expect(client.access_token).to eq(GroupMe.configuration.access_token)
       end
     end
 
-    context 'when :access_token is set' do
-      it 'should not raise an error' do
-        expect { GroupMe::Client.new(access_token: ACCESS_TOKEN) }.not_to raise_error
+    context 'when :access_token is supplied' do
+      let(:client) { GroupMe::Client.new(access_token: new_access_token) }
+
+      it 'should not use configured :access_token' do
+        expect(client.access_token).not_to eq(GroupMe.configuration.access_token)
+      end
+
+      it 'should use the supplied :access_token' do
+        expect(client.access_token).to eq(new_access_token)
       end
     end
   end
 
   describe '#request' do
-    let(:stubbed_data) { { id: 1, name: 'Group' } }
-    let(:stubbed_response_body) { { response: stubbed_data }.to_json }
+    let(:stubbed_data)            { { id: 1, name: 'Group' } }
+    let(:stubbed_response_body)   { { response: stubbed_data }.to_json }
     let(:stubbed_response_status) { 200 }
 
     before do
@@ -30,31 +40,31 @@ RSpec.describe GroupMe::Client do
       )
     end
 
-    context 'when there are no parameters' do
+    context 'when no parameters are supplied' do
       it 'should send the correct HTTP request' do
         client.request(:get, 'groups')
 
-        expect(WebMock).to have_requested(:get, "#{base_url}groups").with(query: { token: ACCESS_TOKEN })
+        expect(WebMock).to have_requested(:get, "#{base_url}groups").with(query: { token: access_token })
       end
     end
 
-    context 'when there are query parameters' do
+    context 'when query parameters are supplied' do
       it 'should send the correct HTTP request' do
         client.request(:get, 'groups', query: { per_page: 1 })
 
-        expect(WebMock).to have_requested(:get, "#{base_url}groups").with(query: { token: ACCESS_TOKEN, per_page: 1 })
+        expect(WebMock).to have_requested(:get, "#{base_url}groups").with(query: { token: access_token, per_page: 1 })
       end
     end
 
-    context 'when there are body parameters' do
+    context 'when body parameters are supplied' do
       it 'should send the correct HTTP request' do
         client.request(:post, 'groups', body: { name: 'Group' })
 
-        expect(WebMock).to have_requested(:post, "#{base_url}groups?token=#{ACCESS_TOKEN}").with(body: { name: 'Group' }.to_json)
+        expect(WebMock).to have_requested(:post, "#{base_url}groups?token=#{access_token}").with(body: { name: 'Group' }.to_json)
       end
     end
 
-    context 'when response is successful' do
+    context 'when the response is successful' do
       let(:stubbed_response_body) { { response: stubbed_data }.to_json }
       let(:stubbed_response_status) { 201 }
 
@@ -71,7 +81,7 @@ RSpec.describe GroupMe::Client do
       end
     end
 
-    context 'when response is unsuccessful' do
+    context 'when the response is unsuccessful' do
       let(:stubbed_response_body) { '' }
       let(:stubbed_response_status) { [404, 'Not Found'] }
 
@@ -161,3 +171,24 @@ RSpec.describe GroupMe::Client do
     end
   end
 end
+
+RSpec.describe GroupMe do
+  include_context :with_default_groupme_configuration
+
+  describe '.client' do
+    it 'should return a GroupMe::Client object' do
+      expect(GroupMe.client).to be_a_instance_of(GroupMe::Client)
+    end
+  end
+
+  describe '.client=' do
+    it 'should set a new default client' do
+      old_client = GroupMe.client
+      new_client = GroupMe::Client.new
+      GroupMe.client = new_client
+
+      expect(GroupMe.client).not_to eq(old_client)
+      expect(GroupMe.client).to eq(new_client)
+    end
+  end
+end

data/spec/groupme/configuration_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe GroupMe::Configuration do
+  before(:each) { GroupMe.reset! }
+
+  describe '#access_token' do
+    context 'when :access_token is not configured' do
+      it 'should raise an error' do
+        expect { GroupMe.configuration.access_token }.to raise_error(GroupMe::MissingConfigurationError)
+      end
+    end
+
+    context 'when :access_token is configured' do
+      include_context :with_default_groupme_configuration
+
+      it 'should return the access_token' do
+        expect(GroupMe.configuration.access_token).to eq(access_token)
+      end
+    end
+  end
+end
+
+RSpec.describe GroupMe do
+  describe '.configuration' do
+    it 'should return a GroupMe::Configuration object' do
+      expect(GroupMe.configuration).to be_an_instance_of(GroupMe::Configuration)
+    end
+  end
+
+  describe '.configuration=' do
+    it 'should set a new default configuration' do
+      old_configuration = GroupMe.configuration
+      new_configuration = GroupMe::Configuration.new
+      GroupMe.configuration = new_configuration
+
+      expect(GroupMe.configuration).not_to eq(old_configuration)
+      expect(GroupMe.configuration).to eq(new_configuration)
+    end
+  end
+
+  describe 'configure' do
+    it 'should set configuration attributes' do
+      GroupMe.configure { |config| config.access_token = access_token }
+
+      expect(GroupMe.configuration.access_token).to eq(access_token)
+    end
+  end
+
+  describe 'reset!' do
+    it 'should reset the configuration' do
+      old_configuration = GroupMe.configuration
+      GroupMe.reset!
+
+      expect(GroupMe.configuration).not_to eq(old_configuration)
+    end
+  end
+end

data/spec/groupme/group_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+RSpec.describe GroupMe::Group do
+  include_context :with_default_groupme_configuration
+
+  let(:base_url) { GroupMe::Client::API_BASE_URL }
+
+  describe '#all' do
+    it 'should send the correct HTTP request' do
+      _groups = GroupMe::Group.all
+
+      expect(WebMock).to have_requested(:get, "#{base_url}groups").with(query: { token: access_token, omit: :memberships, per_page: GroupMe.configuration.groups_per_page })
+    end
+  end
+end

data/spec/support/groupme.rb

@@ -2,5 +2,19 @@
 
 require 'securerandom'
 
-# TEST_ACCOUNT_ACCESS_TOKEN = ''
-ACCESS_TOKEN = defined?(TEST_ACCOUNT_ACCESS_TOKEN) ? TEST_ACCOUNT_ACCESS_TOKEN : SecureRandom.base64(30).tr('+', '0')
+RSpec.shared_context :with_defined_access_token do
+  let(:access_token)     { 'cQOvtsbxn7mHCS6yRimKuKHwXCGtqRwcU4E4NToe' }
+  let(:new_access_token) { SecureRandom.base64(30).tr('+', '0') }
+end
+
+RSpec.shared_context :with_default_groupme_configuration do
+  before(:each) do
+    GroupMe.configure do |config|
+      config.access_token = 'cQOvtsbxn7mHCS6yRimKuKHwXCGtqRwcU4E4NToe'
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include_context :with_defined_access_token
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupme-api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Kinnell Shah
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2019-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -145,6 +145,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -156,9 +157,14 @@ files:
 - lib/groupme-api.rb
 - lib/groupme.rb
 - lib/groupme/client.rb
+- lib/groupme/configuration.rb
+- lib/groupme/errors.rb
+- lib/groupme/group.rb
 - lib/groupme/version.rb
 - lib/groupme_api.rb
 - spec/groupme/client_spec.rb
+- spec/groupme/configuration_spec.rb
+- spec/groupme/group_spec.rb
 - spec/groupme_spec.rb
 - spec/spec_helper.rb
 - spec/support/groupme.rb
@@ -175,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -183,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for GroupMe REST API (v3)