artemis_api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77fb353bfa893d3ff210292444e20d71aa7dd5cf
-  data.tar.gz: 8aaa44cae9c5eec62ff7dfd524e5576ba7d79ce9
+  metadata.gz: 0e8888de9d53b67758011986d95da48078a539d1
+  data.tar.gz: 70e7223008c998a11c2e8c195bb9ab2e44048167
 SHA512:
-  metadata.gz: ea1ad95a03f6f486bc66c629300f4726b912ce7213f54e7d26c2231a30a197688dac2dd93f08038b6d950b9e753f501e4b9f3225e8d1457900f63ad928393b10
-  data.tar.gz: 9d9b6ba166a362890551ae8c8b0d3f489d5b71c32e47f9851175f519ce216fec3702f703401a924673b4d97b32abd1698f816ff44f56b6d7b121e107d755b264
+  metadata.gz: 2f0afda52acc388593a3c704fea8593e09af8713c8d9cfa64c7ec6a9b7e99960465a732202c2b69358371f8f77f5fd59ae48033737e609428073a1d7e41bbd97
+  data.tar.gz: 77da6377c501a342397d87438d1fa41f9d44d21dfd67e434b188bb147d50e5e1768ed8b9070dafc9f3a4c1f1fc38620a834bbf1a4c5c4dc2771820c83191debe

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    artemis_api (0.1.0)
+    artemis_api (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/History.txt

@@ -1,5 +1,10 @@
 # coding: UTF-8
 
+=== 0.3.0 / 2019-11-04
+
+* Added an alternative OAuth flow that can accept an authorization code
+  directly and handle the creation of the OAuth client and token
+
 === 0.2.1 / 2019-10-28
 
 * Minor updates to documentation

data/README.md

@@ -26,13 +26,15 @@ Or install it yourself as:
 
 ## Usage
 
+#### Instantiating your Client
+
 In order to use this gem, you will need to be set up as a developer in the Artemis Portal. If you're not, please contact Artemis CS in order to get that settled.
 
 Once you have developer access, go to Settings and choose "OAuth 2.0 Applications" at the bottom of the sidebar to set up an application by entering the name and redirect URI you wish to use. You will then be provided with an application ID and a secret ID, which you will need in order to authenticate with Artemis.
 
-(Please note that this gem doesn't currently handle OAuth. You will need to do that on your own in order to generate your access token and refresh token. We recommend using the [OAuth2 gem](https://github.com/oauth-xx/oauth2). You'll also need to pass in the `expires_at` for when your token will exipire.)
+The first step to actually using this gem is to instantiate an instance of `ArtemisApi::Client` and there are two different ways to do so depending on if you're handling OAuth in your own app or not.
 
-Once you have all this info, the first step to actually using this gem is to instantiate an instance of `ArtemisApi::Client` - which requires an access token, a refresh token,
+If you intend to do a full OAuth flow, we recommend using the [OAuth2 gem](https://github.com/oauth-xx/oauth2). After authenticating with OAuth and generating your access token and refresh token, you can use them to instantiate your Client instance. You'll also need to pass in the `expires_at` for when your token will expire. That looks like this:
 
 ```ruby
 options = {app_id: 'your_artemis_application_id',
@@ -45,7 +47,7 @@ client = ArtemisApi::Client.new(access_token: 'your_access_token',
                                 options: options)
 ```
 
-Alternatively, instead of passing in options, you can set those values as ENV variables called `ENV['ARTEMIS_OAUTH_APP_ID']`, `ENV['ARTEMIS_OAUTH_APP_SECRET']` and `ENV['ARTEMIS_BASE_URI']`
+Instead of passing in options, you can set those values as ENV variables called `ENV['ARTEMIS_OAUTH_APP_ID']`, `ENV['ARTEMIS_OAUTH_APP_SECRET']` and `ENV['ARTEMIS_BASE_URI']`
 
 They will be automatically detected and then you don't have to pass in any options:
 ```ruby
@@ -54,6 +56,18 @@ client = ArtemisApi::Client.new(access_token: 'your_access_token',
                                 expires_at: token_expires_at)
 ```
 
+Alternatively, if you're working on a command line tool or otherwise not intending to implement a full OAuth flow, you can generate an authorization code directly and pass it in while instantiating your client. Do this by creating an OAuth application in your Artemis settings with `urn:ietf:wg:oauth:2.0:oob` as the callback url. Then, clicking the Authorize button directly beside it on your application show page will provide you directly with an authorization code. Pass it into the Client instantiator like this. (The same rules apply about either passing in options or setting your ENV variables.)
+
+```ruby
+client = ArtemisApi::Client.new(auth_code: 'your_generated_authorization_code')
+```
+
+This can also take an optional `redirect_uri` named param, which you can pass through if you have another callback url you're using. Otherwise if you don't pass anything through that param, it will default to the `urn:ietf:wg:oauth:2.0:oob` address.
+
+Providing your authorization code like this will do the authorization through OAuth for you and create and store your access tokens for you so you don't have to worry about them.
+
+#### Requesting data from Artemis
+
 Once you have a client instance, you can use it to request information from Artemis.
 
 To get user information about the Artemis User that is associated with your application ID:

data/lib/artemis_api/client.rb

@@ -4,22 +4,38 @@ module ArtemisApi
     attr_reader :options, :objects, :access_token, :refresh_token, :oauth_client,
                 :oauth_token, :expires_at
 
-    def initialize(access_token:, refresh_token:, expires_at:, options: {})
+    def initialize(access_token: nil, refresh_token: nil, expires_at: nil, auth_code: nil, redirect_uri: nil, options: {})
+      unless (access_token && refresh_token && expires_at) || auth_code
+        raise ArgumentError.new('You must either provide your access token, refresh token & expires at time, or an authorization code.')
+      end
+
       options[:app_id] ||= ENV['ARTEMIS_OAUTH_APP_ID']
       options[:app_secret] ||= ENV['ARTEMIS_OAUTH_APP_SECRET']
       options[:base_uri] ||= ENV['ARTEMIS_BASE_URI']
       @options = options
-      @access_token = access_token
-      @refresh_token = refresh_token
-      @expires_at = expires_at
+      @objects = {}
 
       @oauth_client = OAuth2::Client.new(@options[:app_id], @options[:app_secret], site: @options[:base_uri])
-      @oauth_token = OAuth2::AccessToken.from_hash(
-                      oauth_client,
-                      {access_token: @access_token,
-                       refresh_token: @refresh_token,
-                       expires_at: @expires_at})
-      @objects = {}
+
+      if access_token && refresh_token && expires_at
+        @access_token = access_token
+        @refresh_token = refresh_token
+        @expires_at = expires_at.to_i
+
+        @oauth_token = OAuth2::AccessToken.from_hash(
+                        oauth_client,
+                        {access_token: @access_token,
+                         refresh_token: @refresh_token,
+                         expires_at: @expires_at})
+      elsif auth_code
+        redirect_uri ||= 'urn:ietf:wg:oauth:2.0:oob'
+
+        @oauth_token = @oauth_client.auth_code.get_token(auth_code, redirect_uri: redirect_uri)
+
+        @access_token = @oauth_token.token
+        @refresh_token = @oauth_token.refresh_token
+        @expires_at = @oauth_token.expires_at
+      end
     end
 
     def find_one(type, id, facility_id: nil, include: nil, force: false)
@@ -84,15 +100,7 @@ module ArtemisApi
     end
 
     def remove_record(type, id)
-      @objects[type].delete(id.to_i) if record_stored?(type, id)
-    end
-
-    def record_stored?(type, id)
-      get_record(type, id).present?
-    end
-
-    def remove_record(type, id)
-      @objects[type].delete(id.to_i)
+      @objects[type]&.delete(id.to_i)
     end
 
     def refresh

data/lib/artemis_api/version.rb

@@ -1,3 +1,3 @@
 module ArtemisApi
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/test/client_test.rb

@@ -15,6 +15,29 @@ class ClientTest < Minitest::Test
     assert_equal false, @client.oauth_token.expired?
   end
 
+  def test_creating_a_client_instance_with_auth_code
+    stub_request(:post, 'http://localhost:3000/oauth/token')
+      .with(body: {"client_id"=>"12345",
+                    "client_secret"=>"67890",
+                    "code"=>"aJ7xsj7",
+                    "grant_type"=>"authorization_code",
+                    "redirect_uri"=>"urn:ietf:wg:oauth:2.0:oob"})
+      .to_return(status: 200, body: {access_token: 'ya29', refresh_token: 'eyJh', expires_in: 7200, token_type: 'Bearer', created_at: Time.now.to_i}.to_json, headers: { 'Content-Type'=> 'application/json;charset=UTF-8'})
+
+    options = {app_id: '12345',
+               app_secret: '67890',
+               base_uri: 'http://localhost:3000'}
+    @client = ArtemisApi::Client.new(auth_code: 'aJ7xsj7', options: options)
+
+    assert_equal '12345', @client.oauth_client.id
+    assert_equal 'ya29', @client.oauth_token.token
+    assert_equal false, @client.oauth_token.expired?
+  end
+
+  def test_creating_an_invalid_client_instance
+    assert_raises(ArgumentError) { ArtemisApi::Client.new(access_token: 'ya29') }
+  end
+
   def test_current_user
     get_client
     stub_user
@@ -22,4 +45,22 @@ class ClientTest < Minitest::Test
     user = @client.current_user
     assert_equal user.class, ArtemisApi::User
   end
+
+  def test_remove_record
+    get_client
+
+    type = 'subscriptions'
+
+    # model type added once, removed twice
+    @client.store_record(type, 1, 'id' => 1)
+    assert_equal 1, @client.get_record(type, 1).id
+    @client.remove_record(type, 1)
+    assert_nil @client.get_record(type, 1)
+    assert_nothing_raised { @client.remove_record(type, 1) }
+
+    # model type not added, attempt to remove one
+    undefined_type = 'something'
+    assert_nil @client.instance_variable_get(:"@objects")[undefined_type]
+    assert_nothing_raised { @client.remove_record(undefined_type, 1) }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artemis_api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jamey Hampton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-28 00:00:00.000000000 Z
+date: 2019-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler