mkmsdk2 0.7.0__tar.gz

mkmsdk2-0.7.0/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2015 Silvano Cerza
+
+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.

mkmsdk2-0.7.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.rst
+include HISTORY.rst

mkmsdk2-0.7.0/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: mkmsdk2
+Version: 0.7.0
+Summary: MagicKardMarket sdk
+Home-page: https://github.com/katry0/mkm-sdk
+Author: Najada
+License: MIT
+Keywords: mkm magickardmarket magiccardmarket sdk mtg magic the gathering card market rest tcg trading card game pokemon wow world of warcraft yugioh
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: requests_oauthlib
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# Fork of mkm-sdk project
+
+This is fork of mkm-sdk project [Original repo](https://github.com/silvanocerza/mkm-sdk).<br>
+
+This fork was created to update the endpoint address in the mkm library, as the maintainer of the original project has not yet responded to [PR](https://github.com/silvanocerza/mkm-sdk/pull/2).
+
+
+# Magic Kard Market Python SDK
+
+[![image](https://badge.fury.io/py/mkmsdk.png)](http://badge.fury.io/py/mkmsdk)
+
+[![image](https://readthedocs.org/projects/mkm-sdk/badge/?version=latest)](http://mkm-sdk.readthedocs.org/en/latest/)
+
+[![image](https://coveralls.io/repos/evonove/mkm-sdk/badge.svg)](https://coveralls.io/r/evonove/mkm-sdk)
+
+[![image](https://travis-ci.org/evonove/mkm-sdk.svg)](https://travis-ci.org/evonove/mkm-sdk)
+
+A simple SDK for dedicated and widget apps working with Magic Kard
+Market.
+
+# Contributing
+
+Feel free to contribute! Submit [a PR following the
+guidelines](https://mkm-sdk.readthedocs.io/en/latest/contributing.html#pull-request-guidelines/)
+and it will be alright.
+
+# Requirements
+
+-   Python 3.8, 3.9, 3.10, 3.11
+-   [Requests](http://docs.python-requests.org/)
+-   [Requests_OAuthlib](https://github.com/requests/requests-oauthlib/)
+
+# Setup
+
+From the command line:
+
+    pip install mkmsdk
+
+For the SDK to work properly you need to create four environment
+variables holding the tokens necessary to create the authorization to
+make requests. You can find them in your Magic Kard Market account page
+under the apps section.
+
+-   `MKM_APP_TOKEN`
+-   `MKM_APP_SECRET`
+-   `MKM_ACCESS_TOKEN`
+-   `MKM_ACCESS_TOKEN_SECRET`
+
+[MKM_ACCESS_TOKEN]{.title-ref} and [MKM_ACCESS_TOKEN_SECRET]{.title-ref}
+need to be set to empty string if you want to use a widget app.
+
+# Usage
+
+First thing to do is import the [Mkm]{.title-ref} class and the API map:
+
+    from mkmsdk.mkm import Mkm
+    from mkmsdk.api_map import _API_MAP
+
+Instance a new instance of Mkm:
+
+    # Using API v1.1
+    mkm = Mkm(_API_MAP["1.1"]["api"], _API_MAP["1.1"]["api_root"])
+    # Using API v2.0
+    mkm = Mkm(_API_MAP["2.0"]["api"], _API_MAP["2.0"]["api_root"])
+
+If you want to test on Magic Card Market\'s sandbox you must use the
+sandbox root endpoint:
+
+    mkm_sandbox = Mkm(_API_MAP["2.0"]["api"], _API_MAP["2.0"]["api_sandbox_root"])
+
+To make a request:
+
+    response = mkm.account_management.account()
+
+    # Formats an endpoint
+    response = mkm.market_place.user(user='SampleUser')
+
+    # Call endpoint with specified parameters
+    response = mkm.account_management.vacation(params={"onVacation": "false"})
+
+This will return a
+[Response](http://docs.python-requests.org/en/latest/api/?highlight=response#requests.Response/)
+object that contains the response from the server.
+
+Note that only [market_place]{.title-ref} requests work when using a
+widget app.
+
+To get a json you can call response.json().
+
+# Tests
+
+Integration tests will be skipped if the four environment variables are
+not set.
+
+-   `MKM_APP_TOKEN`
+-   `MKM_APP_SECRET`
+-   `MKM_ACCESS_TOKEN`
+-   `MKM_ACCESS_TOKEN_SECRET`
+
+Note that some tests will be skipped depending if
+[MKM_ACCESS_TOKEN]{.title-ref} and [MKM_ACCESS_TOKEN_SECRET]{.title-ref}
+are empty strings or not.

mkmsdk2-0.7.0/README.md

@@ -0,0 +1,102 @@
+# Fork of mkm-sdk project
+
+This is fork of mkm-sdk project [Original repo](https://github.com/silvanocerza/mkm-sdk).<br>
+
+This fork was created to update the endpoint address in the mkm library, as the maintainer of the original project has not yet responded to [PR](https://github.com/silvanocerza/mkm-sdk/pull/2).
+
+
+# Magic Kard Market Python SDK
+
+[![image](https://badge.fury.io/py/mkmsdk.png)](http://badge.fury.io/py/mkmsdk)
+
+[![image](https://readthedocs.org/projects/mkm-sdk/badge/?version=latest)](http://mkm-sdk.readthedocs.org/en/latest/)
+
+[![image](https://coveralls.io/repos/evonove/mkm-sdk/badge.svg)](https://coveralls.io/r/evonove/mkm-sdk)
+
+[![image](https://travis-ci.org/evonove/mkm-sdk.svg)](https://travis-ci.org/evonove/mkm-sdk)
+
+A simple SDK for dedicated and widget apps working with Magic Kard
+Market.
+
+# Contributing
+
+Feel free to contribute! Submit [a PR following the
+guidelines](https://mkm-sdk.readthedocs.io/en/latest/contributing.html#pull-request-guidelines/)
+and it will be alright.
+
+# Requirements
+
+-   Python 3.8, 3.9, 3.10, 3.11
+-   [Requests](http://docs.python-requests.org/)
+-   [Requests_OAuthlib](https://github.com/requests/requests-oauthlib/)
+
+# Setup
+
+From the command line:
+
+    pip install mkmsdk
+
+For the SDK to work properly you need to create four environment
+variables holding the tokens necessary to create the authorization to
+make requests. You can find them in your Magic Kard Market account page
+under the apps section.
+
+-   `MKM_APP_TOKEN`
+-   `MKM_APP_SECRET`
+-   `MKM_ACCESS_TOKEN`
+-   `MKM_ACCESS_TOKEN_SECRET`
+
+[MKM_ACCESS_TOKEN]{.title-ref} and [MKM_ACCESS_TOKEN_SECRET]{.title-ref}
+need to be set to empty string if you want to use a widget app.
+
+# Usage
+
+First thing to do is import the [Mkm]{.title-ref} class and the API map:
+
+    from mkmsdk.mkm import Mkm
+    from mkmsdk.api_map import _API_MAP
+
+Instance a new instance of Mkm:
+
+    # Using API v1.1
+    mkm = Mkm(_API_MAP["1.1"]["api"], _API_MAP["1.1"]["api_root"])
+    # Using API v2.0
+    mkm = Mkm(_API_MAP["2.0"]["api"], _API_MAP["2.0"]["api_root"])
+
+If you want to test on Magic Card Market\'s sandbox you must use the
+sandbox root endpoint:
+
+    mkm_sandbox = Mkm(_API_MAP["2.0"]["api"], _API_MAP["2.0"]["api_sandbox_root"])
+
+To make a request:
+
+    response = mkm.account_management.account()
+
+    # Formats an endpoint
+    response = mkm.market_place.user(user='SampleUser')
+
+    # Call endpoint with specified parameters
+    response = mkm.account_management.vacation(params={"onVacation": "false"})
+
+This will return a
+[Response](http://docs.python-requests.org/en/latest/api/?highlight=response#requests.Response/)
+object that contains the response from the server.
+
+Note that only [market_place]{.title-ref} requests work when using a
+widget app.
+
+To get a json you can call response.json().
+
+# Tests
+
+Integration tests will be skipped if the four environment variables are
+not set.
+
+-   `MKM_APP_TOKEN`
+-   `MKM_APP_SECRET`
+-   `MKM_ACCESS_TOKEN`
+-   `MKM_ACCESS_TOKEN_SECRET`
+
+Note that some tests will be skipped depending if
+[MKM_ACCESS_TOKEN]{.title-ref} and [MKM_ACCESS_TOKEN_SECRET]{.title-ref}
+are empty strings or not.

mkmsdk2-0.7.0/mkmsdk/MKMClient.py

@@ -0,0 +1,32 @@
+from oauthlib.oauth1 import Client
+
+
+class MKMClient(Client):
+    """
+    A personalized OAuth1 Client used for Widget Applications
+    """
+
+    def get_oauth_params(self, request):
+        """
+        A modified version of the original method get_oauth_params,
+        this version appends the `oauth_token` parameter as an empty
+        string to the parameters list if not found in it
+        """
+
+        parameters = super(MKMClient, self).get_oauth_params(request)
+
+        oauthParamExist = False
+        # Loop through the parameters to check if oauth_token is found
+        for param in parameters:
+            if "oauth_token" in param:
+                oauthParamExist = True
+                break
+
+        # We append the empty string oauth_token if it's not already there since MKM expects
+        # the OAuth1 Header to have the parameter in any case, this has to be done otherwise
+        # the response will always be 401 Unauthorized
+        # Documentation: https://www.mkmapi.eu/ws/documentation/API:Auth_OAuthHeader
+        if not oauthParamExist:
+            parameters.append(("oauth_token", ""))
+
+        return parameters

mkmsdk2-0.7.0/mkmsdk/MKMOAuth1.py

@@ -0,0 +1,45 @@
+from requests_oauthlib import OAuth1
+from requests.utils import to_native_string
+from urllib.parse import unquote
+
+
+class MKMOAuth1(OAuth1):
+    """
+
+    """
+
+    def __call__(self, r):
+        r = super(MKMOAuth1, self).__call__(r)
+
+        r.prepare_headers(r.headers)
+
+        correct_signature = self.decode_signature(r.headers)
+
+        r.headers.__setitem__("Authorization", correct_signature)
+        r.url = to_native_string(r.url)
+        return r
+
+    @staticmethod
+    def decode_signature(given_header):
+        """
+        Decodes the signature given an header. This is done because MKM
+        expects an authorization header with different parameters encoding
+        specified in section 3.6 of OAuth 1 specification (RFC5849).
+
+        Parameters:
+            `given_header`: Authorization header
+
+        Return:
+            `authorization_string`: Returns a string of the decoded signature
+        """
+
+        authorization_byte = given_header["Authorization"]
+        authorization_string = authorization_byte.decode()
+        signature_position = authorization_string.find('oauth_signature="') + len('oauth_signature="')
+        sub_string_signature = authorization_string[signature_position:]
+
+        decoded_sub_string_signature = unquote(sub_string_signature)
+        authorization_string = authorization_string[:signature_position]
+        authorization_string = "{}{}".format(authorization_string, decoded_sub_string_signature)
+
+        return authorization_string

mkmsdk2-0.7.0/mkmsdk/__init__.py

@@ -0,0 +1,8 @@
+"""Magic Kard Market SDK"""
+
+__title__ = "Magic Kard Market SDK"
+__version__ = "0.7.0"
+__author__ = "Evonove"
+__license__ = "MIT"
+
+VERSION = __version__

mkmsdk2-0.7.0/mkmsdk/api.py

@@ -0,0 +1,98 @@
+from requests import request
+from oauthlib.oauth1.rfc5849 import Client
+
+from .MKMClient import MKMClient
+from . import exceptions
+from .utils import get_mkm_app_token, get_mkm_app_secret, get_mkm_access_token, get_mkm_access_token_secret
+from .MKMOAuth1 import MKMOAuth1
+
+
+class Api:
+    def __init__(self, base_endpoint):
+        """
+        Initializes the endpoint used for requests
+        """
+        self.base_endpoint = base_endpoint
+
+    def request(self, url, method, auth_params=None, **kwargs):
+        """
+        Sends requests to the server with parameters passed
+
+        Params:
+            `url`: URL where request is submitted
+            `method`: Method used for the requests
+            `kwargs`: Optional additional parameters used for the request
+
+        Return:
+            `response`: Returns the response received from the server
+        """
+
+        complete_url = "{}{}".format(self.base_endpoint, url)
+
+        if auth_params is None:
+            auth_params = {}
+
+        auth = self.create_auth(complete_url, **auth_params)
+
+        # Some MKM endpoints might return a 3xx status code but they're not meant to be followed
+        # so disable auto follow of redirections.
+        # For more info see the official MKM documentation:
+        # https://www.mkmapi.eu/ws/documentation/API_1.1:Main_Page#307_Temporary_Redirect
+        response = request(method=method, url=complete_url, auth=auth, allow_redirects=False, **kwargs)
+        return self.handle_response(response)
+
+    def create_auth(self, url, app_token=None, app_secret=None, access_token=None, access_token_secret=None):
+        """
+        Create authorization with MKMOAuth1, if Access Token and Access Token Secret
+        are not found a custom Client is used.
+        This is done because MKM expects an authorization header with certain parameters
+        even if they're empty strings.
+
+        Params:
+            `url`: URL where request is submitted
+            `app_token`: use this app token instead of the one in env vars
+            `app_secret`: use this app secret instead of the one in env vars
+            `access_token`: use this access token instead of the one in env vars
+            `access_token_secret`: use this access token secret instead of the one in env vars
+
+        Return:
+            `auth`: Returns an instance of `MKMOAuth1` with `url` as realm
+        """
+
+        app_token = app_token if app_token is not None else get_mkm_app_token()
+        app_secret = app_secret if app_secret is not None else get_mkm_app_secret()
+        access_token = access_token if access_token is not None else get_mkm_access_token()
+        access_token_secret = access_token_secret if access_token_secret is not None else get_mkm_access_token_secret()
+
+        # If access_token and access_token_secret are empty strings a personalized OAuth1 Client is used.
+        # This is done because that would mean the user is using a Widget Application and having empty strings
+        # as tokens causes issues with the default Client
+        if not access_token and not access_token_secret:
+            client = MKMClient
+        else:
+            client = Client
+
+        return MKMOAuth1(
+            app_token,
+            client_secret=app_secret,
+            resource_owner_key=access_token,
+            resource_owner_secret=access_token_secret,
+            client_class=client,
+            realm=url,
+        )
+
+    def handle_response(self, response):
+        """
+        Check the HTTP response
+
+        Params:
+            `response`: Response received from the server
+        Return:
+            `response`: Returns the response received if positive or raise exception if negative
+        """
+
+        # We don't automatically follow redirects so accept those responses
+        if 200 <= response.status_code <= 399:
+            return response
+        else:
+            raise exceptions.ConnectionError(response)