module HelloSign
  module Api

    #
    # OAuth allows you to perform actions on behalf of other users after they grant you the authorization to do so.
    # For example, you could send signature requests on behalf of your users. This page lays out the basic steps to do that.
    # IMPORTANT
    #
    # With OAuth, you (the app owner) will be charged for all signature requests sent on behalf of other users via your app.
    #
    # @author [hellosign]
    #
    module OAuth

      #
      # Return the oath url where users can give permission for your application to perform actions on their behalf.
      # @param  state [String] used for security and must match throughout the flow for a given user.
      # It can be set to the value of your choice (preferably something random). You should verify it matches the expected value when validating the OAuth callback.
      # @return [type] [description]
      def oauth_url state
        "#{self.oauth_end_point}/oauth/authorize?response_type=code&client_id=#{self.client_id}&state=#{state}"
      end

      #
      # Retrieving the OAuth token
      #
      # @option opts [String] state variable that was used when you created oauth_url for a specific user
      # @option opts [String] code The authorization code passed to your callback when the user granted access
      #
      # @return [Hash] oauth data of the user
      #
      # @example
      #   client = HelloSign::Client.new :api_key => '%apikey%', :client_id => 'cc91c61d00f8bb2ece1428035716b', :client_secret => '1d14434088507ffa390e6f5528465'
      #   client.get_oauth_token :state => '900e06e2', :code =>'1b0d28d90c86c141'
      def get_oauth_token opts
        opts[:client_id] = self.client_id
        opts[:client_secret] = self.client_secret
        opts[:grant_type] = 'authorization_code'
        post('/oauth/token', {:body => opts, :oauth_request => true})

      end


      #
      # refresh user oauth token.
      #
      # @return [Hash] refreshed oauth info
      # @example
      #   client = HelloSign::Client.new :api_key => '%apikey%', :client_id => 'cc91c61d00f8bb2ece1428035716b', :client_secret => '1d14434088507ffa390e6f5528465'
      #
      # @example
      #   client.refresh_oauth_token :refresh_token => 'hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3'
      def refresh_oauth_token refresh_token
        post('/oauth/token', {:body => {:grant_type => 'refresh_token', :refresh_token => refresh_token}, :oauth_request => true})
      end


      #
      # Create new user and get their OAuth token. The user will receive an email asking them to confirm the access being granted. Your app will not be able to perform actions on behalf of this user until they confirm.
      # @option opts [String] email_address new user email address
      # @option opts [String] password new user password
      #
      # @return [Hash] details about new user, including oath data
      def oauth_create_account opts
        opts[:client_id] = self.client_id
        opts[:client_secret] = self.client_secret

        HelloSign::Resource::Account.new post('/account/create', {:body => opts})
      end
    end
  end
end