groupme-api 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bbeb3119bd9c4da20719fc209bc4a56ccdc02a5579983c285d8cf0fa083491b
-  data.tar.gz: fd177ceab8223f93a15a9d9b1dd87fec8817946556fcb726ad260329d4ec8e41
+  metadata.gz: 570e2a4a593dbf2b1230e6613444e778caa494e9a0c04675632e9b0eafab7ed9
+  data.tar.gz: 2432e495fa8a324c8b6da9edd65d2a8cf2ed7ee315a0561e563fd11981a129be
 SHA512:
-  metadata.gz: 994989c42e6e1cdca00f40e5e1bd16184b8a13374e8486a7b60059db2398422c62b8f7413c996d434a17cc4850deda4f89d2ae37554832f84cd6026f8f00bf14
-  data.tar.gz: 2a91c345f5a0452c79737c6fca76ed13936ba91a51994f6303578c289011f24edb2524e14b21c3b8aafac14ea8c7318ff0035d5297b4dbacd0ec4ccfcd4ba550
+  metadata.gz: 3fe24ea9b1550413b7f3da932e134bfc45056c436a3068ae1158adf04a3b9b5f0048c9ea5ded585d541c406ea768595fee2375fc10d2d849bd17ef4ea565f108
+  data.tar.gz: 5c7f672ccafb76b8d36ba8f0d880272b35786d5f770e9be9a1897487394e9a0f0a4d9f39274fda11957b6199bbeb3d8e3d542429d065740eb0c24f18194c714f

data/Gemfile.lock

@@ -1,22 +1,15 @@
 PATH
   remote: .
   specs:
-    groupme-api (0.4.1)
+    groupme-api (0.5.0)
       httpclient (~> 2.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
-    backports (3.11.4)
     coderay (1.1.2)
-    concurrent-ruby (1.0.5)
     coveralls (0.8.22)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -45,18 +38,13 @@ GEM
       rspec (>= 2.99.0, < 4.0)
     hashdiff (0.3.7)
     httpclient (2.8.3)
-    i18n (1.1.0)
-      concurrent-ruby (~> 1.0)
     json (2.1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
-    method_source (0.9.0)
-    minitest (5.11.3)
-    multi_json (1.13.1)
-    mustermann (1.0.3)
+    method_source (0.9.1)
     nenv (0.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
@@ -65,9 +53,6 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     public_suffix (3.0.3)
-    rack (2.0.5)
-    rack-protection (2.0.3)
-      rack
     rake (10.5.0)
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
@@ -78,7 +63,7 @@ GEM
       rspec-mocks (~> 3.8.0)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-mocks (3.8.0)
@@ -93,27 +78,11 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    sinatra (2.0.3)
-      mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.3)
-      tilt (~> 2.0)
-    sinatra-contrib (2.0.3)
-      activesupport (>= 4.0.0)
-      backports (>= 2.8.2)
-      multi_json
-      mustermann (~> 1.0)
-      rack-protection (= 2.0.3)
-      sinatra (= 2.0.3)
-      tilt (>= 1.3, < 3)
-    term-ansicolor (1.6.0)
+    term-ansicolor (1.7.0)
       tins (~> 1.0)
     thor (0.19.4)
-    thread_safe (0.3.6)
-    tilt (2.0.8)
-    tins (1.16.3)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
+    tins (1.18.0)
+    vcr (4.0.0)
     webmock (3.4.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -130,8 +99,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.8)
   simplecov (~> 0.15)
-  sinatra (~> 2.0)
-  sinatra-contrib (~> 2.0)
+  vcr (~> 4.0)
   webmock (~> 3.4)
 
 BUNDLED WITH

data/Guardfile

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-guard :rspec, cmd: 'rspec' do
+guard :rspec, 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/fixtures/(.+)\.json$}) { 'spec' }
   watch(%r{^spec/support/(.+)$}) { 'spec' }
 end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Kinnell Shah
+
+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,4 +1,4 @@
-# GroupMe Ruby Gem (WIP)
+# GroupMe Ruby Gem (BETA)
 [![Build Status](https://travis-ci.org/kinnell/groupme-ruby-gem.svg?branch=master)](https://travis-ci.org/kinnell/groupme-ruby-gem)
 [![Coverage Status](https://coveralls.io/repos/github/kinnell/groupme-ruby-gem/badge.svg?branch=master)](https://coveralls.io/github/kinnell/groupme-ruby-gem?branch=master)
 
@@ -25,9 +25,11 @@ Or install it yourself as:
 Get a developer access token at: https://dev.groupme.com/
 
 ```ruby
-GroupMe.configure do |config|
-    config.access_token = 'ax7snqkoRiJ0yGPsbKSgeBnBEtqeSkALMC2qJPrT'
-end
+require 'groupme'
+
+client = GroupMe::Client.new(
+  access_token: 'ax7snqkoRiJ0yGPsbKSgeBnBEtqeSkALMC2qJPrT'
+)
 ```
 
 ## Usage
@@ -35,14 +37,14 @@ end
 #### Get All Groups
 
 ```ruby
-response = GroupMe::Request.new(:get, 'groups').send
-puts response.body
+response, status = client.get('groups')
+puts response
 ```
 
 
 #### Create A Group
 
 ```ruby
-response = GroupMe::Request.new(:post, 'groups', name: 'Test Group').send
-puts response.body
+response, status = client.post('groups', name: 'New Group')
+puts response
 ```

data/groupme-api.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake',             '~> 10.0'
   spec.add_development_dependency 'rspec',            '~> 3.8'
   spec.add_development_dependency 'simplecov',        '~> 0.15'
-  spec.add_development_dependency 'sinatra',          '~> 2.0'
-  spec.add_development_dependency 'sinatra-contrib',  '~> 2.0'
+  spec.add_development_dependency 'vcr',              '~> 4.0'
   spec.add_development_dependency 'webmock',          '~> 3.4'
 end

data/lib/groupme-api.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'groupme'

data/lib/groupme.rb

@@ -3,25 +3,8 @@
 require 'httpclient'
 require 'json'
 
-require 'groupme/configuration'
-require 'groupme/group'
-require 'groupme/response'
-require 'groupme/request'
+require 'groupme/client'
 require 'groupme/version'
 
 module GroupMe
-  class << self
-    def configuration
-      @configuration ||= Configuration.new
-    end
-  end
-
-  def self.configure
-    self.configuration ||= Configuration.new
-    yield(configuration)
-  end
-
-  def self.reset!
-    @configuration = Configuration.new
-  end
 end

data/lib/groupme/client.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module GroupMe
+  class Client
+    API_BASE_URL = 'https://api.groupme.com/v3/'
+    API_DEFAULT_HEADER = { 'Content-Type': 'application/json' }.freeze
+
+    def initialize(access_token:)
+      @access_token = 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)
+      [parse_response_body(response), response.status]
+    end
+
+    def get(path, query = {})
+      request(:get, path, query: query)
+    end
+
+    def post(path, body = {})
+      request(:post, path, body: body)
+    end
+
+    def delete(path, query = {})
+      request(:delete, path, query: query)
+    end
+
+    private
+
+    def parse_response_body(response)
+      return response.reason unless response.ok?
+
+      JSON.parse(response.body, symbolize_names: true).fetch(:response)
+    end
+  end
+end

data/lib/groupme/version.rb

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

data/lib/groupme_api.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'groupme'

data/spec/groupme/client_spec.rb

@@ -0,0 +1,163 @@
+# 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/' }
+
+  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)
+      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
+      end
+    end
+  end
+
+  describe '#request' do
+    let(:stubbed_data) { { id: 1, name: 'Group' } }
+    let(:stubbed_response_body) { { response: stubbed_data }.to_json }
+    let(:stubbed_response_status) { 200 }
+
+    before do
+      stub_request(:any, /api.groupme.com/).to_return(
+        body: stubbed_response_body,
+        status: stubbed_response_status
+      )
+    end
+
+    context 'when there are no parameters' 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 })
+      end
+    end
+
+    context 'when there are query parameters' 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 })
+      end
+    end
+
+    context 'when there are body parameters' 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)
+      end
+    end
+
+    context 'when response is successful' do
+      let(:stubbed_response_body) { { response: stubbed_data }.to_json }
+      let(:stubbed_response_status) { 201 }
+
+      it 'should parse and return the response' do
+        response, _status = client.request(:post, 'groups')
+
+        expect(response).to eq(stubbed_data)
+      end
+
+      it 'should return the successful status code' do
+        _response, status = client.request(:post, 'groups')
+
+        expect(status).to eq(201)
+      end
+    end
+
+    context 'when response is unsuccessful' do
+      let(:stubbed_response_body) { '' }
+      let(:stubbed_response_status) { [404, 'Not Found'] }
+
+      it 'should return the response reason' do
+        response, _status = client.request(:post, 'groups')
+
+        expect(response).to eq('Not Found')
+      end
+
+      it 'should return the unsuccesful status code' do
+        _response, status = client.request(:post, 'groups')
+
+        expect(status).to eq(404)
+      end
+    end
+  end
+
+  describe '#get' do
+    let(:stubbed_data) { { id: 1, name: 'Group' } }
+    let(:stubbed_response_code) { 200 }
+
+    before do
+      stub_request(:get, /api.groupme.com/).to_return(
+        body: { response: stubbed_data }.to_json,
+        status: stubbed_response_code
+      )
+    end
+
+    it 'should parse and return the response' do
+      response, _status = client.get('groups', per_page: 1)
+
+      expect(response).to eq(stubbed_data)
+    end
+
+    it 'should return the status code' do
+      _response, status = client.get('groups', per_page: 1)
+
+      expect(status).to eq(stubbed_response_code)
+    end
+  end
+
+  describe '#post' do
+    let(:stubbed_data) { { id: 1, name: 'Group' } }
+    let(:stubbed_response_code) { 200 }
+
+    before do
+      stub_request(:post, /api.groupme.com/).to_return(
+        body: { response: stubbed_data }.to_json,
+        status: stubbed_response_code
+      )
+    end
+
+    it 'should parse and return the response' do
+      response, _status = client.post('groups', name: 'Group')
+
+      expect(response).to eq(stubbed_data)
+    end
+
+    it 'should return the status code' do
+      _response, status = client.post('groups', name: 'Group')
+
+      expect(status).to eq(stubbed_response_code)
+    end
+  end
+
+  describe '#delete' do
+    let(:stubbed_data) { 'OK' }
+    let(:stubbed_response_code) { 200 }
+
+    before do
+      stub_request(:delete, /api.groupme.com/).to_return(
+        body: { response: stubbed_data }.to_json,
+        status: stubbed_response_code
+      )
+    end
+
+    it 'should parse and return the response' do
+      response, _status = client.delete('groups', id: 1)
+
+      expect(response).to eq(stubbed_data)
+    end
+
+    it 'should return the status code' do
+      _response, status = client.delete('groups', id: 1)
+
+      expect(status).to eq(stubbed_response_code)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,27 +2,16 @@
 
 require 'simplecov'
 require 'coveralls'
-require 'webmock'
 
 SimpleCov.start
 Coveralls.wear!
-WebMock.enable!
 
-require 'bundler/setup'
 require 'groupme'
-require 'support/fake_groupme'
-require 'securerandom'
 
-RSpec.configure do |config|
-  include WebMock::API
+require 'support/groupme'
+require 'support/vcr'
+require 'support/webmock'
 
+RSpec.configure do |config|
   config.filter_run_when_matching :focus
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-
-  config.before(:each) do
-    stub_request(:any, /api.groupme.com/).to_rack(FakeGroupMe)
-  end
 end